Sign in

v1

latestOpenAPI 3.1.02026-07-23310383.1 KB
Chats

Retrieves multiple chats.

get/api/v1/chats

Query parameters

string[]
OR
string uuid

A UUID v4 string that identifies an entity.

string[]
OR
'widget' | 'waha' | 'whatsapp' | 'instagram' | 'telegram' | 'api'
lastChatMessageCreatedAtEndstring date-time nullable
lastChatMessageCreatedAtStartstring date-time nullable
string[]
OR
string uuid

A UUID v4 string that identifies an entity.

pageNumbernumber

The page number.

The page number.

pageSizenumber

The page size.

The page size.

string[]
OR
string uuid

A UUID v4 string that identifies an entity.

string[]
OR
string uuid

A UUID v4 string that identifies an entity.

searchstring

Headers

authorizationstring required

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Response

Retrieves all chats for the workspace.

createdAtstring date-time required
idstring uuid required

A UUID v4 string that identifies an entity.

isRemovedboolean required
updatedAtstring date-time required
channelIdstring uuid nullable required

A UUID v4 string that identifies an entity.

currentResponderIdstring uuid nullable required

A UUID v4 string that identifies an entity.

lastChatMessageCreatedAtstring date-time nullable required
ownerIdstring uuid required

The super identity ID of the chat owner. Can refer to users.superIdentityId or externalUsers.superIdentityId.

privateMemoryobject required
publicMemoryobject required
responderIdstring uuid required

The super identity ID of the current chat responder. Can refer to agents.superIdentityId or squads.superIdentityId.

titlestring nullable required
workspaceIdstring uuid required

A UUID v4 string that identifies an entity.