Tickets
Retrieves a ticket with details.
A UUID v4 string that identifies an entity.
The API key to use for authentication. Can be created in the api keys section on the workspace settings page.
Retrieves a ticket.
The email of the user currently assigned to the ticket.
The user ID currently assigned to the ticket.
The display name of the user currently assigned to the ticket.
The picture of the user currently assigned to the ticket.
The channel connection ID associated with the ticket chat.
The channel ID associated with the ticket chat.
The display name of the channel associated with the ticket chat.
The type of the channel associated with the ticket chat.
The chat ID associated with the ticket.
Whether the chat associated with the ticket has been soft removed.
The chat owner super identity ID associated with the ticket chat.
When the ticket was completed.
When the ticket was created.
Whether the current responder has an active resolution assessment tool.
The ticket ID represented by this row.
Whether the external chat owner is blocked.
When the associated chat last had activity.
The content preview of the latest message in the associated chat.
When the latest message in the associated chat was created.
The role of the latest message in the associated chat.
When the ticket entered the ongoing state.
The email of the chat owner when the owner is a platform user.
The owner entity type associated with the chat owner super identity.
The identifier of the chat owner when the owner is an external user.
The display name of the chat owner resolved from external users or users.
The number of pending chat messages still waiting on the ticket.
The content preview of the previous message in the associated chat.
When the previous message in the associated chat was created.
The role of the previous message in the associated chat.
The responder entity type assigned to the ticket chat.
The responder ID assigned to the ticket chat.
The display name of the responder assigned to the ticket chat.
The picture of the responder assigned to the ticket chat.
The version ID of the responder entity for this ticket chat.
The version number of the responder entity for this ticket chat.
The lifecycle status of the ticket.
The short summary of the ticket.
The ticketing team ID currently assigned to the ticket.
The display name of the ticketing team currently assigned to the ticket.
The picture of the ticketing team currently assigned to the ticket.
The workspace ID associated with the ticket.
Unauthorized.
Ticket not found.
GET /api/v1/tickets/{id}/details HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*
{
"assigneeEmail": "text",
"assigneeId": "123e4567-e89b-12d3-a456-426614174000",
"assigneeName": "text",
"assigneePicture": "text",
"channelConnectionId": "text",
"channelId": "123e4567-e89b-12d3-a456-426614174000",
"channelName": "text",
"channelType": "api",
"chatId": "123e4567-e89b-12d3-a456-426614174000",
"chatIsRemoved": true,
"chatOwnerId": "123e4567-e89b-12d3-a456-426614174000",
"chatPublicMemory": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"completedAt": "2026-01-01T00:00:00.000Z",
"createdAt": "2026-01-01T00:00:00.000Z",
"hasResolutionAssessmentTool": true,
"id": "123e4567-e89b-12d3-a456-426614174000",
"isOwnerBlocked": true,
"lastActivityAt": "2026-01-01T00:00:00.000Z",
"lastMessageContent": "text",
"lastMessageCreatedAt": "2026-01-01T00:00:00.000Z",
"lastMessageRole": "user",
"ongoingAt": "2026-01-01T00:00:00.000Z",
"ownerEmail": "text",
"ownerEntity": "externalUsers",
"ownerIdentifier": "text",
"ownerName": "text",
"pendingChatMessages": 1,
"penultimateMessageContent": "text",
"penultimateMessageCreatedAt": "2026-01-01T00:00:00.000Z",
"penultimateMessageRole": "user",
"responderEntity": "agents",
"responderId": "123e4567-e89b-12d3-a456-426614174000",
"responderName": "text",
"responderPicture": "text",
"responderVersionId": "123e4567-e89b-12d3-a456-426614174000",
"responderVersionNumber": 1,
"status": "pending",
"summary": "text",
"tags": [
{
"createdAt": "2026-01-01T00:00:00.000Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2026-01-01T00:00:00.000Z",
"activeTicketCount": 1,
"color": "default",
"description": "text",
"name": "text",
"workspaceId": "123e4567-e89b-12d3-a456-426614174000",
"origin": "both"
}
],
"ticketingTeamId": "123e4567-e89b-12d3-a456-426614174000",
"ticketingTeamName": "text",
"ticketingTeamPicture": "text",
"workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}Retrieves multiple tickets with details.
[]A UUID v4 string that identifies an entity.
A UUID v4 string that identifies an entity.
[]A UUID v4 string that identifies an entity.
A UUID v4 string that identifies an entity.
[]A UUID v4 string that identifies an entity.
A UUID v4 string that identifies an entity.
The page number.
1The page size.
10[]A UUID v4 string that identifies an entity.
A UUID v4 string that identifies an entity.
[]A UUID v4 string that identifies an entity.
A UUID v4 string that identifies an entity.
[]A UUID v4 string that identifies an entity.
A UUID v4 string that identifies an entity.
[]A UUID v4 string that identifies an entity.
A UUID v4 string that identifies an entity.
The API key to use for authentication. Can be created in the api keys section on the workspace settings page.
Retrieves all tickets for the workspace.
The email of the user currently assigned to the ticket.
The user ID currently assigned to the ticket.
The display name of the user currently assigned to the ticket.
The picture of the user currently assigned to the ticket.
The channel connection ID associated with the ticket chat.
The channel ID associated with the ticket chat.
The display name of the channel associated with the ticket chat.
The type of the channel associated with the ticket chat.
The chat ID associated with the ticket.
Whether the chat associated with the ticket has been soft removed.
The chat owner super identity ID associated with the ticket chat.
When the ticket was completed.
When the ticket was created.
Whether the current responder has an active resolution assessment tool.
The ticket ID represented by this row.
Whether the external chat owner is blocked.
When the associated chat last had activity.
The content preview of the latest message in the associated chat.
When the latest message in the associated chat was created.
The role of the latest message in the associated chat.
When the ticket entered the ongoing state.
The email of the chat owner when the owner is a platform user.
The owner entity type associated with the chat owner super identity.
The identifier of the chat owner when the owner is an external user.
The display name of the chat owner resolved from external users or users.
The number of pending chat messages still waiting on the ticket.
The content preview of the previous message in the associated chat.
When the previous message in the associated chat was created.
The role of the previous message in the associated chat.
The responder entity type assigned to the ticket chat.
The responder ID assigned to the ticket chat.
The display name of the responder assigned to the ticket chat.
The picture of the responder assigned to the ticket chat.
The version ID of the responder entity for this ticket chat.
The version number of the responder entity for this ticket chat.
The lifecycle status of the ticket.
The short summary of the ticket.
The ticketing team ID currently assigned to the ticket.
The display name of the ticketing team currently assigned to the ticket.
The picture of the ticketing team currently assigned to the ticket.
The workspace ID associated with the ticket.
Unauthorized.
GET /api/v1/tickets/details?status=pending HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*
[
{
"assigneeEmail": "text",
"assigneeId": "123e4567-e89b-12d3-a456-426614174000",
"assigneeName": "text",
"assigneePicture": "text",
"channelConnectionId": "text",
"channelId": "123e4567-e89b-12d3-a456-426614174000",
"channelName": "text",
"channelType": "api",
"chatId": "123e4567-e89b-12d3-a456-426614174000",
"chatIsRemoved": true,
"chatOwnerId": "123e4567-e89b-12d3-a456-426614174000",
"chatPublicMemory": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"completedAt": "2026-01-01T00:00:00.000Z",
"createdAt": "2026-01-01T00:00:00.000Z",
"hasResolutionAssessmentTool": true,
"id": "123e4567-e89b-12d3-a456-426614174000",
"isOwnerBlocked": true,
"lastActivityAt": "2026-01-01T00:00:00.000Z",
"lastMessageContent": "text",
"lastMessageCreatedAt": "2026-01-01T00:00:00.000Z",
"lastMessageRole": "user",
"ongoingAt": "2026-01-01T00:00:00.000Z",
"ownerEmail": "text",
"ownerEntity": "externalUsers",
"ownerIdentifier": "text",
"ownerName": "text",
"pendingChatMessages": 1,
"penultimateMessageContent": "text",
"penultimateMessageCreatedAt": "2026-01-01T00:00:00.000Z",
"penultimateMessageRole": "user",
"responderEntity": "agents",
"responderId": "123e4567-e89b-12d3-a456-426614174000",
"responderName": "text",
"responderPicture": "text",
"responderVersionId": "123e4567-e89b-12d3-a456-426614174000",
"responderVersionNumber": 1,
"status": "pending",
"summary": "text",
"tags": [
{
"createdAt": "2026-01-01T00:00:00.000Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2026-01-01T00:00:00.000Z",
"activeTicketCount": 1,
"color": "default",
"description": "text",
"name": "text",
"workspaceId": "123e4567-e89b-12d3-a456-426614174000",
"origin": "both"
}
],
"ticketingTeamId": "123e4567-e89b-12d3-a456-426614174000",
"ticketingTeamName": "text",
"ticketingTeamPicture": "text",
"workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}
]Completes a ticket.
A UUID v4 string that identifies an entity.
The API key to use for authentication. Can be created in the api keys section on the workspace settings page.
A UUID v4 string that identifies an entity.
The ticket was completed.
A UUID v4 string that identifies an entity.
The id of the user assigned to the ticket.
A UUID v4 string that identifies an entity.
The type of ticket creation: takeover (human intervention) or handover (agent automatic creation).
The last time the ticket was viewed by the assignee.
A brief summary of the chat up until the ticket was created.
The id of the ticketing team responsible for the ticket.
Unauthorized.
Ticket not found.
Ticket is not ongoing.
PATCH /api/v1/tickets/{id}/complete HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 49
{
"userId": "123e4567-e89b-12d3-a456-426614174000"
}{
"createdAt": "2026-01-01T00:00:00.000Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2026-01-01T00:00:00.000Z",
"assigneeId": "123e4567-e89b-12d3-a456-426614174000",
"chatId": "123e4567-e89b-12d3-a456-426614174000",
"circumstance": "takeover",
"completedAt": "2026-01-01T00:00:00.000Z",
"lastViewedAt": "2026-01-01T00:00:00.000Z",
"ongoingAt": "2026-01-01T00:00:00.000Z",
"status": "pending",
"summary": "text",
"ticketingTeamId": "123e4567-e89b-12d3-a456-426614174000"
}Creates a new ticket.
The API key to use for authentication. Can be created in the api keys section on the workspace settings page.
A UUID v4 string that identifies an entity.
The id of the ticketing team responsible for the ticket.
A UUID v4 string that identifies an entity.
The ticket was created.
A UUID v4 string that identifies an entity.
The id of the user assigned to the ticket.
A UUID v4 string that identifies an entity.
The type of ticket creation: takeover (human intervention) or handover (agent automatic creation).
The last time the ticket was viewed by the assignee.
A brief summary of the chat up until the ticket was created.
The id of the ticketing team responsible for the ticket.
Unauthorized.
Chat not found or assignee not found.
Ticket already exists.
POST /api/v1/tickets HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 177
{
"chatId": "123e4567-e89b-12d3-a456-426614174000",
"ticketingTeamId": "123e4567-e89b-12d3-a456-426614174000",
"assigneeId": "123e4567-e89b-12d3-a456-426614174000",
"status": "pending"
}{
"createdAt": "2026-01-01T00:00:00.000Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2026-01-01T00:00:00.000Z",
"assigneeId": "123e4567-e89b-12d3-a456-426614174000",
"chatId": "123e4567-e89b-12d3-a456-426614174000",
"circumstance": "takeover",
"completedAt": "2026-01-01T00:00:00.000Z",
"lastViewedAt": "2026-01-01T00:00:00.000Z",
"ongoingAt": "2026-01-01T00:00:00.000Z",
"status": "pending",
"summary": "text",
"ticketingTeamId": "123e4567-e89b-12d3-a456-426614174000"
}Creates tags for a ticket.
A UUID v4 string that identifies an entity.
The API key to use for authentication. Can be created in the api keys section on the workspace settings page.
A UUID v4 string that identifies an entity.
The tag was attached to the ticket.
The tag associated with the ticket.
The ticket associated with the tag.
Unauthorized.
Ticket or tag not found.
POST /api/v1/tickets/{ticketId}/tags HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 48
{
"tagId": "123e4567-e89b-12d3-a456-426614174000"
}{
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"tagId": "123e4567-e89b-12d3-a456-426614174000",
"ticketId": "123e4567-e89b-12d3-a456-426614174000",
"tag": {
"createdAt": "2026-01-01T00:00:00.000Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2026-01-01T00:00:00.000Z",
"activeTicketCount": 1,
"color": "default",
"description": "text",
"name": "text",
"workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}
}Removes a tag from a ticket.
A UUID v4 string that identifies an entity.
A UUID v4 string that identifies an entity.
The API key to use for authentication. Can be created in the api keys section on the workspace settings page.
The tag was removed from the ticket.
An informative message for a call that has no effective result to be returned.
Unauthorized.
Ticket tag relationship not found.
DELETE /api/v1/tickets/{ticketId}/tags/{tagId} HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*
{
"message": "text"
}Takes over a ticket.
A UUID v4 string that identifies an entity.
The API key to use for authentication. Can be created in the api keys section on the workspace settings page.
A UUID v4 string that identifies an entity.
The ticket was taken over.
A UUID v4 string that identifies an entity.
The id of the user assigned to the ticket.
A UUID v4 string that identifies an entity.
The type of ticket creation: takeover (human intervention) or handover (agent automatic creation).
The last time the ticket was viewed by the assignee.
A brief summary of the chat up until the ticket was created.
The id of the ticketing team responsible for the ticket.
Unauthorized.
Ticket not found.
Ticket is not ongoing or already assigned.
PATCH /api/v1/tickets/{id}/takeover HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 53
{
"assigneeId": "123e4567-e89b-12d3-a456-426614174000"
}{
"createdAt": "2026-01-01T00:00:00.000Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2026-01-01T00:00:00.000Z",
"assigneeId": "123e4567-e89b-12d3-a456-426614174000",
"chatId": "123e4567-e89b-12d3-a456-426614174000",
"circumstance": "takeover",
"completedAt": "2026-01-01T00:00:00.000Z",
"lastViewedAt": "2026-01-01T00:00:00.000Z",
"ongoingAt": "2026-01-01T00:00:00.000Z",
"status": "pending",
"summary": "text",
"ticketingTeamId": "123e4567-e89b-12d3-a456-426614174000"
}Updates the assignee of a ticket.
A UUID v4 string that identifies an entity.
The API key to use for authentication. Can be created in the api keys section on the workspace settings page.
A UUID v4 string that identifies an entity.
The ticket was updated.
A UUID v4 string that identifies an entity.
The id of the user assigned to the ticket.
A UUID v4 string that identifies an entity.
The type of ticket creation: takeover (human intervention) or handover (agent automatic creation).
The last time the ticket was viewed by the assignee.
A brief summary of the chat up until the ticket was created.
The id of the ticketing team responsible for the ticket.
Unauthorized.
Ticket not found or assignee not found.
Ticket is completed.
PATCH /api/v1/tickets/{id}/assignee HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 53
{
"assigneeId": "123e4567-e89b-12d3-a456-426614174000"
}{
"createdAt": "2026-01-01T00:00:00.000Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2026-01-01T00:00:00.000Z",
"assigneeId": "123e4567-e89b-12d3-a456-426614174000",
"chatId": "123e4567-e89b-12d3-a456-426614174000",
"circumstance": "takeover",
"completedAt": "2026-01-01T00:00:00.000Z",
"lastViewedAt": "2026-01-01T00:00:00.000Z",
"ongoingAt": "2026-01-01T00:00:00.000Z",
"status": "pending",
"summary": "text",
"ticketingTeamId": "123e4567-e89b-12d3-a456-426614174000"
}Last updated