Texa DeskDevelopers

Tickets API · Tickets

List tickets

GET/api/v1/accounts/{account_id}/tickets

The tickets the person sees (through one of their conversations), 25 a page by default.

Authorization

api_access_tokenheaderrequired

A person's access token (Texa Desk, Profile settings → Access token) or an agent bot's token, in the api_access_token header. It acts as that person, with their role's permissions.

Path parameters

account_idintegerrequired

The account's id

Query parameters

qstring

A reference (AUD-1001 or 1001), else words of the title

state_idinteger
categorystring
openboolean
ticket_type_idinteger
assignee_idstring

me, none or a person's id

team_idinteger
contact_idinteger
prioritystring
overdueboolean
duestring
kindstring
created_fromstring (date)
created_tostring (date)
sortstring
pageinteger
per_pageinteger

Responses

200

A page of tickets

payloadarray of object
payload[].idinteger
payload[].numberinteger
payload[].referencestring
payload[].titlestring
payload[].kindstring

One of: ticket, tracker.

payload[].typeobject
payload[].type.idinteger
payload[].type.namestring
payload[].type.iconstring
payload[].type.complaintboolean

A complaint

payload[].type.sensitiveboolean

Shown to the customer only once they are verified

payload[].type.audiencestring

One of: customer, internal.

payload[].stateobject
payload[].state.idinteger
payload[].state.namestring

The state as your team sees it

payload[].state.customer_namestring

The state as the customer sees it

payload[].state.categorystring

One of: submitted, in_progress, waiting_on_customer, resolved.

payload[].state.systemboolean

One of the four states every account has

payload[].state.positioninteger
payload[].state.archivedboolean
payload[].assignee_idinteger
payload[].team_idinteger
payload[].prioritystring

One of: low, medium, high, urgent.

payload[].branch_idinteger
payload[].created_viastring

One of: person, texa_ai, rule, inbox, customer, api.

payload[].main_conversation_idinteger

The display id of its main conversation

payload[].due_atinteger

Unix seconds: when the type's promise is due. Null when the type promises nothing. Overdue means due_at has passed and the category is not resolved

payload[].acknowledged_atinteger
payload[].resolved_atinteger
payload[].customer_wrote_after_resolution_atinteger
payload[].created_atinteger
payload[].updated_atnumber
payload[].reopened_countinteger
payload[].conversations_countinteger
payload[].open_conversations_countinteger
metaobject
meta.countinteger
meta.current_pageinteger
meta.per_pageinteger
meta.total_pagesinteger