v1

latestOpenAPI 3.1.02026-07-23310383.1 KB
Tickets

Retrieves a ticket with details.

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

Path parameters

idstring uuid required

A UUID v4 string that identifies an entity.

A UUID v4 string that identifies an entity.

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

assigneeEmailstring nullable required

The email of the user currently assigned to the ticket.

assigneeIdstring uuid nullable required

The user ID currently assigned to the ticket.

assigneeNamestring nullable required

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

assigneePicturestring nullable required

The picture of the user currently assigned to the ticket.

channelIdstring uuid nullable required

The channel ID associated with the ticket chat.

channelNamestring nullable required

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

channelType'api' | 'widget' | 'waha' | 'whatsapp' | 'instagram' | 'telegram' | 'null' nullable required

The type of the channel associated with the ticket chat.

chatIdstring uuid required

The chat ID associated with the ticket.

chatIsRemovedboolean required

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

chatOwnerIdstring uuid required

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

chatPublicMemoryobject required

The shared chat memory snapshot associated with the ticket.

completedAtstring date-time nullable required

When the ticket was completed.

createdAtstring date-time required

When the ticket was created.

idstring uuid required

The ticket ID represented by this row.

isOwnerBlockedboolean nullable required

Whether the external chat owner is blocked.

ongoingAtstring date-time nullable required

When the ticket entered the ongoing state.

ownerEmailstring nullable required

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

ownerEntity'externalUsers' | 'users' required

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

ownerIdentifierstring nullable required

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

ownerNamestring nullable required

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

pendingChatMessagesinteger required

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

responderEntity'agents' | 'squads' required

The responder entity type assigned to the ticket chat.

responderIdstring uuid required

The responder ID assigned to the ticket chat.

responderNamestring required

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

responderPicturestring nullable required

The picture of the responder assigned to the ticket chat.

responderVersionIdstring uuid nullable required

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

responderVersionNumberinteger nullable required

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

status'pending' | 'ongoing' | 'completed' required

The lifecycle status of the ticket.

summarystring required

The short summary of the ticket.

ticketingTeamIdstring uuid nullable required

The ticketing team ID currently assigned to the ticket.

ticketingTeamNamestring nullable required

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

ticketingTeamPicturestring nullable required

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

workspaceIdstring uuid required

The workspace ID associated with the ticket.