Sign in
Users

List users

Lists all users in the customer account. The response shows each user's corpus access and customer-level authorizations.

To enable, disable, or edit the roles of a user, use the Update User endpoint.

get/v2/users

Query parameters

limitinteger

The maximum number of users to return at one time.

page_keystring

The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.

corpus_keystring

A user-provided key for a corpus.

Example:my-corpus

Filter users by access to this corpus.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

List of users.

Example response

{
  "users": [
    {
      "metadata": {
        "console_mode": "business"
      }
    }
  ],
  "metadata": {
    "page_key": "eyJvZmZzZXQiOjF9"
  }
}

Changes

Changed in 2 of the 13 revisions of this API.21

  • c94fd099d78b11See the full diff
    • ●

      added the new metrics_viewer enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • fca567a46b3a1See the full diff
    • ●

      added the new agent_end_user enum value to the //// response property for the response status

      response-property-enum-value-added