GET /users

Searches for a user in the business of the user making the request

Authentication and Authorisation

Requires API Access Token Requires Basic Authentication (Username/Password) Requires one of the following roles
True True BusinessAdministrator

Request Information


Name Source Description
searchCriteria Part of the URI query string The search Criteria.

Parameter Properties

  • searchCriteria
    • Keyword
      Keyword to be used for searching.
    • Roles
      Gets or sets the roles.
    • PageIndex
      Zero-based page index.
    • ResultsPerPage
      Number of results per page.
      Remarks: Mandatory. Accepted range is 1 to 100.