Get users

Returns a collection of users



To get collection of users, first create an instance of CrayonApiClient and get the token using CrayonApiClient instance.

Then call Users.Get() method to get users by passing token.

var username = <username>;
var client = new CrayonApiClient("");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;

var result = client.Users.Get(token);


Request Syntax:

Method Request URI

Request Parameters:

Name Type Description
search string Search for username, firstname or lastname
page int Pagination, starts at page 1
pageSize int Pagination, Number of objects to return
role int 1 for regular user, 2 for tenant admin

Request Headers:

The following HTTP request headers are supported

Header Type Description
Authorization string Required. The authorization token in the form Bearer <token>.
Accept string Specifies the request and response type, “application/json”.
Content-Type string Specifies the media type of the resource, “application/json”.

Request Example:

GET $"{search}&page={page}&pageSize={pageSize}"
Accept : application/json
Content-Type: application/json
Authorization : Bearer < Token >


If successful, this method returns a list of User resources in the response body.

  "Items": [
      "Id": "2DAB448F-4677-40A2-9A27-FCC090A65066",
      "TenantId": 1,
      "UserName": "",
      "FirstName": "Firstname",
      "LastName": "Lastname",
      "Email": "",
      "EmailConfirmed": false,
      "LockoutEnabled": false,
      "LockoutEnd": null,
      "PhoneNumber": null,
      "PhoneNumberConfirmed": false,
      "TwoFactorEnabled": false
  "TotalHits": 1

Response success and error codes:

Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters.

Error Codes Description
200 Ok The request has succeeded.
401 Unauthorized The request requires user authentication. If the request already included Authorization credentials, then the 401 (Unauthorized) status code means that authorization has been refused for those credentials. It is a non-retryable error condition.