Console users

A user is a person who signs in to Check Console on behalf of your organization, such as a member of your support or operations team. Users belong to your organization as a whole. They are not tied to a single company, and they are separate from the employees and contractors that your companies pay.

The Users API lets you read your organization's users. It is read-only: you can list users and get a single user. You add, edit, and deactivate users in Console. Users cannot be deleted, only deactivated.

What a user looks like

Each user has an id (prefixed with usr_), a first_name, a last_name, the email address they sign in with, a created_at timestamp, and a status. See the user object for the full schema.

A user's status is either active or inactive. An inactive user can no longer sign in to Console, but they stay in the API so that you can still look up who they were. If you only want people who currently have access, filter out users whose status is inactive on your side.

Check staff who support your account are never included.

Listing users

GET /users returns your users, newest first, with cursor-based pagination. The default page size is 25 and the maximum is 1000, set with the limit query parameter. See Pagination for how to walk through pages.

curl "https://api.checkhq.com/users?limit=100" \
  -H "Authorization: Bearer <API_KEY>"

{
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "usr_8Wd2LkXJ0yTq4mHvR3sN",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "[email protected]",
      "created_at": "2025-06-11T14:32:08.512946Z",
      "status": "active"
    }
  ]
}

Getting a user

GET /users/{user} returns one user. Pass the user's usr_ ID. For backwards compatibility, the path also accepts the legacy UUID that older integrations may have stored.

curl https://api.checkhq.com/users/usr_8Wd2LkXJ0yTq4mHvR3sN \
  -H "Authorization: Bearer <API_KEY>"

If the ID does not match a user in your organization, the API returns a 404.

Common uses

• Show your own team who has Console access, and which accounts are inactive.
• Match a usr_ ID that you see elsewhere in your data to a name and email address.
• Audit access by comparing the users Check returns with the people you expect to have access.