Tickets

get

Retrieves a ticket with details.

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 ticket.

application/json

assigneeEmailstring · nullableRequired

The email of the user currently assigned to the ticket.

assigneeIdstring · uuid · nullableRequired

The user ID currently assigned to the ticket.

assigneeNamestring · nullableRequired

The display name of the user currently assigned to the ticket.

assigneePicturestring · nullableRequired

The picture of the user currently assigned to the ticket.

channelIdstring · uuid · nullableRequired

The channel ID associated with the ticket chat.

channelNamestring · nullableRequired

The display name of the channel associated with the ticket chat.

channelTypestring · enum · nullableRequired

The type of the channel associated with the ticket chat.

Possible values:

chatIdstring · uuidRequired

The chat ID associated with the ticket.

chatIsRemovedbooleanRequired

Whether the chat associated with the ticket has been soft removed.

chatOwnerIdstring · uuidRequired

The chat owner super identity ID associated with the ticket chat.

completedAtstring · date-time · nullableRequired

When the ticket was completed.

createdAtstring · date-timeRequired

When the ticket was created.

idstring · uuidRequired

The ticket ID represented by this row.

isOwnerBlockedboolean · nullableRequired

Whether the external chat owner is blocked.

ongoingAtstring · date-time · nullableRequired

When the ticket entered the ongoing state.

ownerEmailstring · nullableRequired

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

ownerEntitystring · enumRequired

The owner entity type associated with the chat owner super identity.

Possible values:

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.

pendingChatMessagesintegerRequired

The number of pending chat messages still waiting on the ticket.

responderEntitystring · enumRequired

The responder entity type assigned to the ticket chat.

Possible values:

responderIdstring · uuidRequired

The responder ID assigned to the ticket chat.

responderNamestringRequired

The display name of the responder assigned to the ticket chat.

responderPicturestring · nullableRequired

The picture of the responder assigned to the ticket chat.

responderVersionIdstring · uuid · nullableRequired

The version ID of the responder entity for this ticket chat.

responderVersionNumberinteger · nullableRequired

The version number of the responder entity for this ticket chat.

statusstring · enumRequired

The lifecycle status of the ticket.

Possible values:

summarystringRequired

The short summary of the ticket.

ticketingTeamIdstring · uuid · nullableRequired

The ticketing team ID currently assigned to the ticket.

ticketingTeamNamestring · nullableRequired

The display name of the ticketing team currently assigned to the ticket.

ticketingTeamPicturestring · nullableRequired

The picture of the ticketing team currently assigned to the ticket.

workspaceIdstring · uuidRequired

The workspace ID associated with the ticket.

401

Unauthorized.

application/json

404

Ticket not found.

application/json

get

/api/v1/tickets/{id}/details

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",
  "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-06-11T18:48:11.871Z",
  "createdAt": "2026-06-11T18:48:11.871Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isOwnerBlocked": true,
  "ongoingAt": "2026-06-11T18:48:11.871Z",
  "ownerEmail": "text",
  "ownerEntity": "externalUsers",
  "ownerIdentifier": "text",
  "ownerName": "text",
  "pendingChatMessages": 1,
  "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-06-11T18:48:11.871Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "updatedAt": "2026-06-11T18:48:11.871Z",
      "activeTicketCount": 1,
      "color": "default",
      "description": "text",
      "name": "text",
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "ticketingTeamId": "123e4567-e89b-12d3-a456-426614174000",
  "ticketingTeamName": "text",
  "ticketingTeamPicture": "text",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}

get

Retrieves multiple tickets with details.

Query parameters

assigneeIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

string · uuidOptional

A UUID v4 string that identifies an entity.

chatIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

string · uuidOptional

A UUID v4 string that identifies an entity.

includeRemovedboolean · nullableOptional

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.

string · uuidOptional

A UUID v4 string that identifies an entity.

responderVersionIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

string · uuidOptional

A UUID v4 string that identifies an entity.

searchstringOptional

statusstring · enumRequiredPossible values:

tagIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

string · uuidOptional

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 all tickets for the workspace.

application/json

assigneeEmailstring · nullableRequired

The email of the user currently assigned to the ticket.

assigneeIdstring · uuid · nullableRequired

The user ID currently assigned to the ticket.

assigneeNamestring · nullableRequired

The display name of the user currently assigned to the ticket.

assigneePicturestring · nullableRequired

The picture of the user currently assigned to the ticket.

channelIdstring · uuid · nullableRequired

The channel ID associated with the ticket chat.

channelNamestring · nullableRequired

The display name of the channel associated with the ticket chat.

channelTypestring · enum · nullableRequired

The type of the channel associated with the ticket chat.

Possible values:

chatIdstring · uuidRequired

The chat ID associated with the ticket.

chatIsRemovedbooleanRequired

Whether the chat associated with the ticket has been soft removed.

chatOwnerIdstring · uuidRequired

The chat owner super identity ID associated with the ticket chat.

completedAtstring · date-time · nullableRequired

When the ticket was completed.

createdAtstring · date-timeRequired

When the ticket was created.

idstring · uuidRequired

The ticket ID represented by this row.

isOwnerBlockedboolean · nullableRequired

Whether the external chat owner is blocked.

ongoingAtstring · date-time · nullableRequired

When the ticket entered the ongoing state.

ownerEmailstring · nullableRequired

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

ownerEntitystring · enumRequired

The owner entity type associated with the chat owner super identity.

Possible values:

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.

pendingChatMessagesintegerRequired

The number of pending chat messages still waiting on the ticket.

responderEntitystring · enumRequired

The responder entity type assigned to the ticket chat.

Possible values:

responderIdstring · uuidRequired

The responder ID assigned to the ticket chat.

responderNamestringRequired

The display name of the responder assigned to the ticket chat.

responderPicturestring · nullableRequired

The picture of the responder assigned to the ticket chat.

responderVersionIdstring · uuid · nullableRequired

The version ID of the responder entity for this ticket chat.

responderVersionNumberinteger · nullableRequired

The version number of the responder entity for this ticket chat.

statusstring · enumRequired

The lifecycle status of the ticket.

Possible values:

summarystringRequired

The short summary of the ticket.

ticketingTeamIdstring · uuid · nullableRequired

The ticketing team ID currently assigned to the ticket.

ticketingTeamNamestring · nullableRequired

The display name of the ticketing team currently assigned to the ticket.

ticketingTeamPicturestring · nullableRequired

The picture of the ticketing team currently assigned to the ticket.

workspaceIdstring · uuidRequired

The workspace ID associated with the ticket.

401

Unauthorized.

application/json

get

/api/v1/tickets/details

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",
    "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-06-11T18:48:11.871Z",
    "createdAt": "2026-06-11T18:48:11.871Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isOwnerBlocked": true,
    "ongoingAt": "2026-06-11T18:48:11.871Z",
    "ownerEmail": "text",
    "ownerEntity": "externalUsers",
    "ownerIdentifier": "text",
    "ownerName": "text",
    "pendingChatMessages": 1,
    "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-06-11T18:48:11.871Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T18:48:11.871Z",
        "activeTicketCount": 1,
        "color": "default",
        "description": "text",
        "name": "text",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "ticketingTeamId": "123e4567-e89b-12d3-a456-426614174000",
    "ticketingTeamName": "text",
    "ticketingTeamPicture": "text",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
  }
]

patch

Completes a ticket.

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

userIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Responses

200

The ticket was completed.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired

assigneeIdstring · uuid · nullableRequired

The id of the user assigned to the ticket.

chatIdstring · uuidRequired

A UUID v4 string that identifies an entity.

circumstancestring · enumRequired

The type of ticket creation: takeover (human intervention) or handover (agent automatic creation).

Possible values:

completedAtstring · date-time · nullableRequired

lastViewedAtstring · date-time · nullableRequired

The last time the ticket was viewed by the assignee.

ongoingAtstring · date-time · nullableRequired

statusstring · enumRequiredPossible values:

summarystringRequired

A brief summary of the chat up until the ticket was created.

ticketingTeamIdstring · uuid · nullableRequired

The id of the ticketing team responsible for the ticket.

401

Unauthorized.

application/json

404

Ticket not found.

application/json

412

Ticket is not ongoing.

application/json

patch

/api/v1/tickets/{id}/complete

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-06-11T18:48:11.871Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T18:48:11.871Z",
  "assigneeId": "123e4567-e89b-12d3-a456-426614174000",
  "chatId": "123e4567-e89b-12d3-a456-426614174000",
  "circumstance": "takeover",
  "completedAt": "2026-06-11T18:48:11.871Z",
  "lastViewedAt": "2026-06-11T18:48:11.871Z",
  "ongoingAt": "2026-06-11T18:48:11.871Z",
  "status": "pending",
  "summary": "text",
  "ticketingTeamId": "123e4567-e89b-12d3-a456-426614174000"
}

post

Creates a new ticket.

Header parameters

authorizationstringRequired

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

Body

chatIdstring · uuidRequired

A UUID v4 string that identifies an entity.

ticketingTeamIdstring · uuid · nullableRequired

The id of the ticketing team responsible for the ticket.

assigneeIdstring · uuidRequired

A UUID v4 string that identifies an entity.

statusstring · enumRequiredPossible values:

Responses

200

The ticket was created.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired

assigneeIdstring · uuid · nullableRequired

The id of the user assigned to the ticket.

chatIdstring · uuidRequired

A UUID v4 string that identifies an entity.

circumstancestring · enumRequired

The type of ticket creation: takeover (human intervention) or handover (agent automatic creation).

Possible values:

completedAtstring · date-time · nullableRequired

lastViewedAtstring · date-time · nullableRequired

The last time the ticket was viewed by the assignee.

ongoingAtstring · date-time · nullableRequired

statusstring · enumRequiredPossible values:

summarystringRequired

A brief summary of the chat up until the ticket was created.

ticketingTeamIdstring · uuid · nullableRequired

The id of the ticketing team responsible for the ticket.

401

Unauthorized.

application/json

404

Chat not found or assignee not found.

application/json

409

Ticket already exists.

application/json

post

/api/v1/tickets

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-06-11T18:48:11.871Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T18:48:11.871Z",
  "assigneeId": "123e4567-e89b-12d3-a456-426614174000",
  "chatId": "123e4567-e89b-12d3-a456-426614174000",
  "circumstance": "takeover",
  "completedAt": "2026-06-11T18:48:11.871Z",
  "lastViewedAt": "2026-06-11T18:48:11.871Z",
  "ongoingAt": "2026-06-11T18:48:11.871Z",
  "status": "pending",
  "summary": "text",
  "ticketingTeamId": "123e4567-e89b-12d3-a456-426614174000"
}

post

Creates tags for a ticket.

Path parameters

ticketIdstring · 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

tagIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Responses

200

The tag was attached to the ticket.

application/json

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

tagIdstring · uuidRequired

The tag associated with the ticket.

ticketIdstring · uuidRequired

The ticket associated with the tag.

401

Unauthorized.

application/json

404

Ticket or tag not found.

application/json

post

/api/v1/tickets/{ticketId}/tags

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-06-11T18:48:11.871Z",
  "updatedAt": "2026-06-11T18:48:11.871Z",
  "tagId": "123e4567-e89b-12d3-a456-426614174000",
  "ticketId": "123e4567-e89b-12d3-a456-426614174000",
  "tag": {
    "createdAt": "2026-06-11T18:48:11.871Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "updatedAt": "2026-06-11T18:48:11.871Z",
    "activeTicketCount": 1,
    "color": "default",
    "description": "text",
    "name": "text",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

delete

Removes a tag from a ticket.

Path parameters

tagIdstring · uuidRequired

A UUID v4 string that identifies an entity.

ticketIdstring · 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 tag was removed from the ticket.

application/json

messagestringRequired

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

401

Unauthorized.

application/json

404

Ticket tag relationship not found.

application/json

delete

/api/v1/tickets/{ticketId}/tags/{tagId}

DELETE /api/v1/tickets/{ticketId}/tags/{tagId} HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

{
  "message": "text"
}

patch

Takes over a ticket.

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

assigneeIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Responses

200

The ticket was taken over.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired

assigneeIdstring · uuid · nullableRequired

The id of the user assigned to the ticket.

chatIdstring · uuidRequired

A UUID v4 string that identifies an entity.

circumstancestring · enumRequired

The type of ticket creation: takeover (human intervention) or handover (agent automatic creation).

Possible values:

completedAtstring · date-time · nullableRequired

lastViewedAtstring · date-time · nullableRequired

The last time the ticket was viewed by the assignee.

ongoingAtstring · date-time · nullableRequired

statusstring · enumRequiredPossible values:

summarystringRequired

A brief summary of the chat up until the ticket was created.

ticketingTeamIdstring · uuid · nullableRequired

The id of the ticketing team responsible for the ticket.

401

Unauthorized.

application/json

404

Ticket not found.

application/json

412

Ticket is not ongoing or already assigned.

application/json

patch

/api/v1/tickets/{id}/takeover

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-06-11T18:48:11.871Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T18:48:11.871Z",
  "assigneeId": "123e4567-e89b-12d3-a456-426614174000",
  "chatId": "123e4567-e89b-12d3-a456-426614174000",
  "circumstance": "takeover",
  "completedAt": "2026-06-11T18:48:11.871Z",
  "lastViewedAt": "2026-06-11T18:48:11.871Z",
  "ongoingAt": "2026-06-11T18:48:11.871Z",
  "status": "pending",
  "summary": "text",
  "ticketingTeamId": "123e4567-e89b-12d3-a456-426614174000"
}

patch

Updates the assignee of a ticket.

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

assigneeIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Responses

200

The ticket was updated.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired

assigneeIdstring · uuid · nullableRequired

The id of the user assigned to the ticket.

chatIdstring · uuidRequired

A UUID v4 string that identifies an entity.

circumstancestring · enumRequired

The type of ticket creation: takeover (human intervention) or handover (agent automatic creation).

Possible values:

completedAtstring · date-time · nullableRequired

lastViewedAtstring · date-time · nullableRequired

The last time the ticket was viewed by the assignee.

ongoingAtstring · date-time · nullableRequired

statusstring · enumRequiredPossible values:

summarystringRequired

A brief summary of the chat up until the ticket was created.

ticketingTeamIdstring · uuid · nullableRequired

The id of the ticketing team responsible for the ticket.

401

Unauthorized.

application/json

404

Ticket not found or assignee not found.

application/json

412

Ticket is completed.

application/json

patch

/api/v1/tickets/{id}/assignee

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-06-11T18:48:11.871Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T18:48:11.871Z",
  "assigneeId": "123e4567-e89b-12d3-a456-426614174000",
  "chatId": "123e4567-e89b-12d3-a456-426614174000",
  "circumstance": "takeover",
  "completedAt": "2026-06-11T18:48:11.871Z",
  "lastViewedAt": "2026-06-11T18:48:11.871Z",
  "ongoingAt": "2026-06-11T18:48:11.871Z",
  "status": "pending",
  "summary": "text",
  "ticketingTeamId": "123e4567-e89b-12d3-a456-426614174000"
}

PreviousTicketing Teams NextTiers

Last updated 1 minute ago