GET
/
users
curl --request GET \
  --url https://api.contextual.ai/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "users": [
    {
      "email": "<string>",
      "is_tenant_admin": false,
      "roles": [
        "AGENT_USER"
      ],
      "per_agent_roles": [
        {
          "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "roles": [
            "AGENT_USER"
          ],
          "grant": true
        }
      ],
      "id": "<string>"
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
search
string

Query to filter users by email

​
cursor
string

Cursor for the beginning of the current page

​
limit
integer
default:50

Number of users to return

​
deactivated
boolean
default:false

When set to true, return deactivated users instead.

Response

200
application/json
Successful Response
​
users
object[]
required

List of users

The schema used for listing existing (activated / deactivated) users. Need to keep in sync with frontend/src/types/admin.ts.

​
next_cursor
string | null

Cursor for the beginning of the next page

Was this page helpful?