Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Users

List users

Endpoint used to list user resources

get/users

Query parameters

cursorstring

Last pagination reference

limitinteger

max number of Users returned

onlyAssignableboolean

Will only show users that can be assigned to a work order

emailstring[]

Filter users by email. You can filter for multiple users by specifying multiple emails like so: /users?email=user1@example.com&email=user2@example.com. Note that if you are using special characters in a url, you will need to URI encode them in order for us to interprete them correctly. For example, + should be encoded as %2B and though we accept @, they should still be encoded as %40. So filtering for email user1+test@example.com, you would use /users?email=user1%2Btest%example.com in your URI

expandstring[]

To expand multiple fields: expand=role&expand=extra_fields

Headers

x-organization-idinteger

Required if using a multi organizations token

Response

Successfully fetched Users list

nextCursorstring nullable required

The cursor to retrieve the next page of Users.

nextPageUrlstring nullable required

Path with query parameters that can be used to retrieve the next page of Users.

Example response

{
  "users": [
    {
      "id": 963,
      "firstName": "John",
      "lastName": "Doe",
      "email": "user@example.com",
      "phoneNumber": "415-555-0100",
      "authType": "SAML",
      "hourlyRate": 120,
      "lastVisitedAt": "2026-05-06T12:34:56.000Z",
      "createdAt": "2026-05-06T12:34:56.000Z",
      "role": "MEMBER",
      "extraFields": {
        "Department": "Engineering"
      }
    }
  ]
}