Request Access
GitHub
Request Access

Users

List all users

Documentation

Client API Reference

Admin API Reference

Community & Support

GitHub

Admin API

Introduction
Authentication
Specification

Agents

GET
List all agents
POST
Create an agent
GET
Retrieve an agent
POST
Update an agent
DEL
Delete an agent
GET
Retrieve agent configuration
POST
Update agent configuration
POST
Activate an agent
POST
Deactivate an agent

Users

GET
List all users
POST
Create a user
GET
Retrieve a user
POST
Update a user
DEL
Delete a user

Users

List all users

Returns a list of users that belong to the current project. The users are returned sorted by creation date, with the most recently created users appearing first.

GET

users

Key

string

Key

Required

string

live_mode

string

live_mode

string

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

Query Parameters

live_mode

string | null

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

Response

200 - application/json

data

object[]

required

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

discord github twitter linkedin