Skip to main content
GET
List assistants

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

The ID of the org

Query Parameters

Filter assistants by name.

Maximum string length: 256
page
number

Page number

take
number

Number of items to take

next
string

Next page token (Only used on special endpoints)

Response

200 - application/json

An array of assistants.

id
string
required
name
string
required

The name of the assistant

deleted
boolean
required

Whether the assistant has been soft-deleted

secret_key
string | null
required

The secret key to create session hashes

avatar_url
string | null
required

The URL of the avatar photo

config
object
required

Schema for the configuration of an assistant

channels
object[]
required
actions
object[]
required
contact_fields
object[]
required
spending_cap
object | null
required

A monthly spending cap on a user, an agent or an assistant

created_at
string<date-time> | null
required
updated_at
string<date-time> | null
required
members
object[]

Bounded preview of assigned members (list reads only) for the collage

members_count
number

Total number of assigned members (list reads only)