Sign in
User

List users

List all users in your organization.

get/user

Query parameters

organization_idstring required

Filter users by the ID of the organization.

emailstring

Filter users by their email address.

first_namestring

Filter users by their first name.

last_namestring

Filter users by their last name.

status'active' | 'inactive' | 'pending' | 'invited'

Filter users by their status. Multiple values can be provided, separated by commas.

idstring

Filter users by their ID. Multiple values can be provided, separated by commas.

type'machine' | 'person'

Filter users by user type.

offsetinteger

Number of items to skip. Defaults to 0.

limitinteger

Maximum number of items to return per page. Maximum is 200.

Response

The list of users matching the query.

Example response

{
  "results": [
    {
      "id": 123456,
      "email": "alex.mgr@crypto-inc.com",
      "first_name": "Alex",
      "last_name": "Doe",
      "organization_id": 1234,
      "status": "active",
      "avatar": "https://my-avatar-url.com",
      "type": "person",
      "provider": "cognito",
      "nrn": "organization=123",
      "send_invite": true,
      "metadata": {
        "key": "value"
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.