Skip to content

List operators, including inactive operators

GET
/operators
curl --request GET \
--url 'https://optlo.com/api/v1/operators?limit=50' \
--header 'Authorization: Bearer <token>'

Requires operators:read.

limit
integer
default: 50 >= 1 <= 100

Maximum number of resources to return on one page.

cursor
string

Opaque cursor from the preceding page. Bound to workspace, resource and filters; survives key rotation.

Success

Media typeapplication/json
Show child attributesHide child attributes
data
required

Resources on this page.

array of dictionaries
Show child attributesHide child attributes
id
required

Unique identifier for the assistant or operator.

string
name
required

Display name shown to users.

string
avatarUrl
required

URL of the avatar image.

nullable string
active
required

Whether the operator is an active member of this workspace.

boolean
nextCursor
required

Pass this cursor to retrieve the next page. Null when no further page is available. When polling events in ascending order, retain the cursor even on empty pages.

nullable string

Example

{
"data": [
{
"id": "acc_tQ8nL4zR6mB2xP7k",
"name": "Alex Chen",
"avatarUrl": null,
"active": true
}
],
"nextCursor": null
}