List users

• limit#numberin queryintegerminimum 1maximum 100

  The max number of items to return.

• cursor#stringin queryUUID

  The id of the last item from the previous page. Used to fetch the next page.

• status#stringin query

  Filter on invitation status

  PENDINGCLAIMEDCANCELED

• accountId#stringin queryUUID

  Id of the account. Only useful for Platform customers to filter users by child accounts.

• search#stringin queryat least 3 characters

  Full text search on the firstName, lastName and email fields. Minimum length: 3

  Required in the spec, optional for the API.

• sort#stringin query

  Sorting field and order

  createdAt:asccreatedAt:descfirstName:ascfirstName:desc

No field is described in the spec.

• userId#stringalways returned

• firstName#stringalways returned

• lastName#stringalways returned

• email#stringalways returned

• phone#string

• pictureUrl#string

• role#Rolealways returned

  ADMINMEMBERPAYROLL_MANAGER

• persona#Persona

  CSRMARKETINGHRSALESCOMMUNICATIONPRODUCTSMBOTHER

• accountId#string

• createdAt#string (date-time)always returned

• updatedAt#string (date-time)always returned

Errors

• 400A field is missing, has the wrong type, or is not part of the request schema.

  Every request with a body or query is validated.

  {
    "statusCode": 400,
    "message": [
      "amount must not be less than 1",
      "property foo should not exist"
    ],
    "error": "Bad Request"
  }

• 401Unauthorized

  Missing, expired or invalid access token.

  {
    "statusCode": 401,
    "message": "Unauthorized"
  }

• 403Account closed

  {
    "message": "Account closed",
    "code": "ACCOUNT_CLOSED"
  }