Pular para o conteúdo
ZaiaZaiaZaia

/api/v1/chats (GET)

GET
/api/v1/chats
curl --request GET \
  --url 'https://api.endless.zaia.app/api/v1/chats?channelTypes=widget&channelTypes=widget-test&channelTypes=waha&channelTypes=whatsapp&channelTypes=instagram&channelTypes=telegram&channelTypes=api&pageNumber=1&pageSize=10'

Retrieves multiple chats.

Parameters

Seção intitulada “Parameters”

Query Parameters

Seção intitulada “Query Parameters”
channelIds
Any of:
Array<string>
channelTypes
Any of:
Array<string>
Allowed values: widget widget-test waha whatsapp instagram telegram api
lastChatMessageCreatedAtEnd
string format: date-time
nullable
lastChatMessageCreatedAtStart
string format: date-time
nullable
ownerIds
Any of:
Array<string>
pageNumber

The page number.

number
default: 1 >= 1

The page number.

pageSize

The page size.

number
default: 10 >= 1 <= 100

The page size.

responderIds
Any of:
Array<string>
responderVersionIds
Any of:
Array<string>
search
string

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

Retrieves all chats for the workspace.

Media typeapplication/json
Array<object>
object
createdAt
required
string format: date-time
id
required

A UUID v4 string that identifies an entity.

string format: uuid
isRemoved
required
boolean
updatedAt
required
string format: date-time
channelId
required

A UUID v4 string that identifies an entity.

string format: uuid
nullable
conversationVersion
required
integer
currentResponderId
required

A UUID v4 string that identifies an entity.

string format: uuid
nullable
lastActivityAt
required
string format: date-time
lastChatMessageCreatedAt
required
string format: date-time
nullable
ownerId
required

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

string format: uuid
privateMemory
required
object
key
additional properties
Any of:
string
publicMemory
required
object
key
additional properties
Any of:
string
responderId
required

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

string format: uuid
title
required
string
nullable
workspaceId
required

A UUID v4 string that identifies an entity.

string format: uuid
Examplegenerated
[
  {
    "createdAt": "2026-04-15T12:00:00Z",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "isRemoved": true,
    "updatedAt": "2026-04-15T12:00:00Z",
    "channelId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "conversationVersion": 1,
    "currentResponderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "lastActivityAt": "2026-04-15T12:00:00Z",
    "lastChatMessageCreatedAt": "2026-04-15T12:00:00Z",
    "ownerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "privateMemory": {
      "additionalProperty": "example"
    },
    "publicMemory": {
      "additionalProperty": "example"
    },
    "responderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "title": "example",
    "workspaceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
]

401

Seção intitulada “401”

Unauthorized.

Media typeapplication/json

The description of a known exception.

object
code

The error code.

string
cta

The error call-to-action.

object
type
required
string
Allowed values: support-contact
url
required
string format: uri
feedback
required

The error feedback.

object
enUs
string
esEs
string
ptBr
string
message
required

The error message.

string
name
required

The error name.

string
Example
{
  "cta": {
    "type": "support-contact"
  }
}