COcontextualai
/users

Get Users

Changed on

Retrieve a list of users.

get/users

Request

  • Base URL
    https://api.contextual.ai/v1
  • URL
    https://api.contextual.ai/v1/users
  • Auth
    HTTP bearer

Query parameters

searchstring

Query to filter users by email

cursorstring

Cursor for the beginning of the current page

limitinteger

Number of users to return

deactivatedboolean

When set to true, return deactivated users instead.

Response

Successful Response

next_cursorstring nullable

Cursor for the beginning of the next page

Changes

  • 4abdda722de9Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

  • c8152db45500Revision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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