List all users

List all users

curl --request GET \
  --url https://api.proficientai.com/users \
  --header 'Key: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "object": "user",
      "created_at": 123,
      "external_id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "live_mode": true,
      "updated_at": 123
    }
  ]
}

GET

users

List all users

curl --request GET \
  --url https://api.proficientai.com/users \
  --header 'Key: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "object": "user",
      "created_at": 123,
      "external_id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "live_mode": true,
      "updated_at": 123
    }
  ]
}

Authorizations

Key

string

header

required

Query Parameters

live_mode

string | null

If set to "false", only test users will be returned.

Response

data

User · object[]

required

Show child attributes

data.id

string

required

The unique identifier of the user

data.object

enum<string>

required

The type of the User object

Available options:

user

data.created_at

integer

required

The time at which the object was created, measured in milliseconds since the Unix epoch

data.external_id

string

required

A string that uniquely identifies the user within your project. Ensure that this is the ID that you use to identify the user in your system e.g. database ID, Firebase Auth ID etc. Failing to do so may cause unexpected bugs and errors in your application.

data.first_name

string

required

The first name of the user.

data.last_name

string

required

The last name of the user.

data.live_mode

boolean

required

Whether the user exists in live mode. This will be false if the user is a test user.

data.updated_at

integer

required

The time at which the object was last updated, measured in milliseconds since the Unix epoch

Deactivate an agent Create a user

⌘I

Admin API

Agents

Users

Authorizations

Query Parameters

Response