Chats

get

Retrieves a chat with details.

Path parameters

idstring · uuidRequired

A UUID v4 string that identifies an entity.

Query parameters

responderVersionIdstringOptional

Header parameters

authorizationstringRequired

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

Responses

200

Retrieves a chat.

application/json

channelIdstring · uuid · nullableRequired

The channel ID associated with the chat.

channelNamestring · nullableRequired

The display name of the channel associated with the chat.

channelTypestring · enum · nullableRequired

The type of the channel associated with the chat.

Possible values:

createdAtstring · date-timeRequired

When the chat was created.

idstring · uuidRequired

The chat ID represented by this row.

isOwnerBlockedboolean · nullableRequired

Whether the external chat owner is blocked.

isRemovedbooleanRequired

Whether the chat has been soft removed.

lastMessageContentstring · nullableRequired

The content preview of the latest message in the chat.

lastMessageCreatedAtstring · date-time · nullableRequired

When the latest message in the chat was created.

lastMessageRolestring · enum · nullableRequired

The role of the latest message in the chat.

Possible values:

ownerEmailstring · nullableRequired

The email of the chat owner when the owner is a platform user.

ownerIdstring · uuidRequired

The external user ID that owns the chat.

ownerIdentifierstring · nullableRequired

The identifier of the chat owner when the owner is an external user.

ownerNamestring · nullableRequired

The display name of the chat owner resolved from external users or users.

penultimateMessageContentstring · nullableRequired

The content preview of the message immediately before the latest one.

penultimateMessageCreatedAtstring · date-time · nullableRequired

When the message immediately before the latest one was created.

penultimateMessageRolestring · enum · nullableRequired

The role of the message immediately before the latest one.

Possible values:

responderEntitystring · enumRequired

The responder entity type currently assigned to the chat.

Possible values:

responderIdstring · uuidRequired

The responder ID currently assigned to the chat.

responderNamestringRequired

The display name of the responder assigned to the chat.

responderPicturestring · nullableRequired

The picture of the responder assigned to the chat.

responderVersionIdstring · uuid · nullableRequired

The version ID of the responder entity for this chat.

responderVersionNumberinteger · nullableRequired

The version number of the responder entity for this chat.

ticketIdstring · uuid · nullableRequired

The ticket ID currently linked to the chat, when one exists.

ticketStatusstring · enum · nullableRequired

The status of the ticket currently linked to the chat, when one exists.

Possible values:

titlestring · nullableRequired

The title of the chat.

workspaceIdstring · uuidRequired

The workspace ID associated with the chat.

401

Unauthorized.

application/json

404

Chat not found.

application/json

get

/api/v1/chats/{id}/details

HTTPcURLJavaScriptPython

GET /api/v1/chats/{id}/details HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

{
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "channelName": "text",
  "channelType": "api",
  "createdAt": "2026-06-11T20:41:12.909Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isOwnerBlocked": true,
  "isRemoved": true,
  "lastMessageContent": "text",
  "lastMessageCreatedAt": "2026-06-11T20:41:12.909Z",
  "lastMessageRole": "user",
  "ownerEmail": "text",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerIdentifier": "text",
  "ownerName": "text",
  "penultimateMessageContent": "text",
  "penultimateMessageCreatedAt": "2026-06-11T20:41:12.909Z",
  "penultimateMessageRole": "user",
  "publicMemory": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "responderEntity": "agents",
  "responderId": "123e4567-e89b-12d3-a456-426614174000",
  "responderName": "text",
  "responderPicture": "text",
  "responderVersionId": "123e4567-e89b-12d3-a456-426614174000",
  "responderVersionNumber": 1,
  "ticketId": "123e4567-e89b-12d3-a456-426614174000",
  "ticketStatus": "pending",
  "title": "text",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}

get

Retrieves multiple chats with details.

Query parameters

channelIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

or

string · uuidOptional

A UUID v4 string that identifies an entity.

pageNumbernumber · min: 1Optional

The page number.

Default: 1

pageSizenumber · min: 1 · max: 100Optional

The page size.

Default: 10

responderIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

or

string · uuidOptional

A UUID v4 string that identifies an entity.

responderVersionIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

or

string · uuidOptional

A UUID v4 string that identifies an entity.

searchstringOptional

Header parameters

authorizationstringRequired

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

Responses

200

Retrieves all chats for the workspace.

application/json

channelIdstring · uuid · nullableRequired

The channel ID associated with the chat.

channelNamestring · nullableRequired

The display name of the channel associated with the chat.

channelTypestring · enum · nullableRequired

The type of the channel associated with the chat.

Possible values:

createdAtstring · date-timeRequired

When the chat was created.

idstring · uuidRequired

The chat ID represented by this row.

isOwnerBlockedboolean · nullableRequired

Whether the external chat owner is blocked.

isRemovedbooleanRequired

Whether the chat has been soft removed.

lastMessageContentstring · nullableRequired

The content preview of the latest message in the chat.

lastMessageCreatedAtstring · date-time · nullableRequired

When the latest message in the chat was created.

lastMessageRolestring · enum · nullableRequired

The role of the latest message in the chat.

Possible values:

ownerEmailstring · nullableRequired

The email of the chat owner when the owner is a platform user.

ownerIdstring · uuidRequired

The external user ID that owns the chat.

ownerIdentifierstring · nullableRequired

The identifier of the chat owner when the owner is an external user.

ownerNamestring · nullableRequired

The display name of the chat owner resolved from external users or users.

penultimateMessageContentstring · nullableRequired

The content preview of the message immediately before the latest one.

penultimateMessageCreatedAtstring · date-time · nullableRequired

When the message immediately before the latest one was created.

penultimateMessageRolestring · enum · nullableRequired

The role of the message immediately before the latest one.

Possible values:

responderEntitystring · enumRequired

The responder entity type currently assigned to the chat.

Possible values:

responderIdstring · uuidRequired

The responder ID currently assigned to the chat.

responderNamestringRequired

The display name of the responder assigned to the chat.

responderPicturestring · nullableRequired

The picture of the responder assigned to the chat.

responderVersionIdstring · uuid · nullableRequired

The version ID of the responder entity for this chat.

responderVersionNumberinteger · nullableRequired

The version number of the responder entity for this chat.

ticketIdstring · uuid · nullableRequired

The ticket ID currently linked to the chat, when one exists.

ticketStatusstring · enum · nullableRequired

The status of the ticket currently linked to the chat, when one exists.

Possible values:

titlestring · nullableRequired

The title of the chat.

workspaceIdstring · uuidRequired

The workspace ID associated with the chat.

401

Unauthorized.

application/json

get

/api/v1/chats/details

HTTPcURLJavaScriptPython

GET /api/v1/chats/details HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

[
  {
    "channelId": "123e4567-e89b-12d3-a456-426614174000",
    "channelName": "text",
    "channelType": "api",
    "createdAt": "2026-06-11T20:41:12.909Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isOwnerBlocked": true,
    "isRemoved": true,
    "lastMessageContent": "text",
    "lastMessageCreatedAt": "2026-06-11T20:41:12.909Z",
    "lastMessageRole": "user",
    "ownerEmail": "text",
    "ownerId": "123e4567-e89b-12d3-a456-426614174000",
    "ownerIdentifier": "text",
    "ownerName": "text",
    "penultimateMessageContent": "text",
    "penultimateMessageCreatedAt": "2026-06-11T20:41:12.909Z",
    "penultimateMessageRole": "user",
    "publicMemory": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "responderEntity": "agents",
    "responderId": "123e4567-e89b-12d3-a456-426614174000",
    "responderName": "text",
    "responderPicture": "text",
    "responderVersionId": "123e4567-e89b-12d3-a456-426614174000",
    "responderVersionNumber": 1,
    "ticketId": "123e4567-e89b-12d3-a456-426614174000",
    "ticketStatus": "pending",
    "title": "text",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
  }
]

get

Retrieves multiple chats.

Query parameters

channelIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

or

string · uuidOptional

A UUID v4 string that identifies an entity.

channelTypesany ofOptionalDefault: ["widget","waha","whatsapp","instagram","api"]

or

string · enumOptionalPossible values:

lastChatMessageCreatedAtEndstring · date-time · nullableOptional

lastChatMessageCreatedAtStartstring · date-time · nullableOptional

ownerIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

or

string · uuidOptional

A UUID v4 string that identifies an entity.

pageNumbernumber · min: 1Optional

The page number.

Default: 1

pageSizenumber · min: 1 · max: 100Optional

The page size.

Default: 10

responderIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

or

string · uuidOptional

A UUID v4 string that identifies an entity.

responderVersionIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

or

string · uuidOptional

A UUID v4 string that identifies an entity.

searchstringOptional

Header parameters

authorizationstringRequired

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

Responses

200

Retrieves all chats for the workspace.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired

updatedAtstring · date-timeRequired

channelIdstring · uuid · nullableRequired

A UUID v4 string that identifies an entity.

currentResponderIdstring · uuid · nullableRequired

A UUID v4 string that identifies an entity.

lastChatMessageCreatedAtstring · date-time · nullableRequired

ownerIdstring · uuidRequired

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

responderIdstring · uuidRequired

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

titlestring · nullableRequired

workspaceIdstring · uuidRequired

A UUID v4 string that identifies an entity.

401

Unauthorized.

application/json

get

/api/v1/chats

HTTPcURLJavaScriptPython

GET /api/v1/chats HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

[
  {
    "createdAt": "2026-06-11T20:41:12.909Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isRemoved": true,
    "updatedAt": "2026-06-11T20:41:12.909Z",
    "channelId": "123e4567-e89b-12d3-a456-426614174000",
    "currentResponderId": "123e4567-e89b-12d3-a456-426614174000",
    "lastChatMessageCreatedAt": "2026-06-11T20:41:12.909Z",
    "ownerId": "123e4567-e89b-12d3-a456-426614174000",
    "privateMemory": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "publicMemory": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "responderId": "123e4567-e89b-12d3-a456-426614174000",
    "title": "text",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
  }
]

post

Creates a new chat.

Header parameters

authorizationstringRequired

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

Body

application/json

channelIdstring · uuid · nullableRequired

A UUID v4 string that identifies an entity.

ownerIdstring · uuidRequired

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

titlestring · nullableRequired

Responses

200

The chat was created.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired

updatedAtstring · date-timeRequired

channelIdstring · uuid · nullableRequired

A UUID v4 string that identifies an entity.

currentResponderIdstring · uuid · nullableRequired

A UUID v4 string that identifies an entity.

lastChatMessageCreatedAtstring · date-time · nullableRequired

ownerIdstring · uuidRequired

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

responderIdstring · uuidRequired

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

titlestring · nullableRequired

workspaceIdstring · uuidRequired

A UUID v4 string that identifies an entity.

400

Invalid data provided.

application/json

401

Unauthorized.

application/json

404

Channel or responder not found.

application/json

post

/api/v1/chats

HTTPcURLJavaScriptPython

POST /api/v1/chats HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "privateMemory": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "publicMemory": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "title": "text"
}

{
  "createdAt": "2026-06-11T20:41:12.909Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isRemoved": true,
  "updatedAt": "2026-06-11T20:41:12.909Z",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "currentResponderId": "123e4567-e89b-12d3-a456-426614174000",
  "lastChatMessageCreatedAt": "2026-06-11T20:41:12.909Z",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "privateMemory": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "publicMemory": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "responderId": "123e4567-e89b-12d3-a456-426614174000",
  "title": "text",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}

get

Retrieves a chat.

Path parameters

idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters

authorizationstringRequired

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

Responses

200

Retrieves a chat.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired

updatedAtstring · date-timeRequired

channelIdstring · uuid · nullableRequired

A UUID v4 string that identifies an entity.

currentResponderIdstring · uuid · nullableRequired

A UUID v4 string that identifies an entity.

lastChatMessageCreatedAtstring · date-time · nullableRequired

ownerIdstring · uuidRequired

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

responderIdstring · uuidRequired

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

titlestring · nullableRequired

workspaceIdstring · uuidRequired

A UUID v4 string that identifies an entity.

401

Unauthorized.

application/json

404

Chat not found.

application/json

get

/api/v1/chats/{id}

HTTPcURLJavaScriptPython

GET /api/v1/chats/{id} HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

{
  "createdAt": "2026-06-11T20:41:12.909Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isRemoved": true,
  "updatedAt": "2026-06-11T20:41:12.909Z",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "currentResponderId": "123e4567-e89b-12d3-a456-426614174000",
  "lastChatMessageCreatedAt": "2026-06-11T20:41:12.909Z",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "privateMemory": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "publicMemory": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "responderId": "123e4567-e89b-12d3-a456-426614174000",
  "title": "text",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}

delete

Removes a chat.

Path parameters

idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters

authorizationstringRequired

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

Responses

200

The chat was removed.

application/json

messagestringRequired

An informative message for a call that has no effective result to be returned.

401

Unauthorized.

application/json

404

Chat not found.

application/json

delete

/api/v1/chats/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/chats/{id} HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

{
  "message": "text"
}

patch

Updates a chat.

Path parameters

idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters

authorizationstringRequired

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

Body

application/json

lastChatMessageCreatedAtstring · date-time · nullableOptional

titlestring · nullableOptional

Responses

200

The chat was updated.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired

updatedAtstring · date-timeRequired

channelIdstring · uuid · nullableRequired

A UUID v4 string that identifies an entity.

currentResponderIdstring · uuid · nullableRequired

A UUID v4 string that identifies an entity.

lastChatMessageCreatedAtstring · date-time · nullableRequired

ownerIdstring · uuidRequired

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

responderIdstring · uuidRequired

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

titlestring · nullableRequired

workspaceIdstring · uuidRequired

A UUID v4 string that identifies an entity.

401

Unauthorized.

application/json

404

The chat was not found.

application/json

patch

/api/v1/chats/{id}

HTTPcURLJavaScriptPython

PATCH /api/v1/chats/{id} HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "lastChatMessageCreatedAt": "2026-06-11T20:41:12.909Z",
  "privateMemory": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "publicMemory": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "title": "text"
}

{
  "createdAt": "2026-06-11T20:41:12.909Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isRemoved": true,
  "updatedAt": "2026-06-11T20:41:12.909Z",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "currentResponderId": "123e4567-e89b-12d3-a456-426614174000",
  "lastChatMessageCreatedAt": "2026-06-11T20:41:12.909Z",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "privateMemory": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "publicMemory": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "responderId": "123e4567-e89b-12d3-a456-426614174000",
  "title": "text",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}