Qodex.ai

List tickets

GET https://desk-api-{{APP_ID}}.sendbird.com/platform/v1/tickets

List tickets

Retrieves a list of all tickets in the application.

For more information, visit:

https://sendbird.com/docs/desk/v1/platform-api/guides/ticket#2-list-tickets

URL Parameters

Required

Request Params

KeyDatatypeRequiredDescription
limitstringOPTIONAL: Specifies the number of results to return per page. Acceptable values are 1 to 500, inclusive. (Default: 50)
offsetstringOPTIONAL: Specifies the number of results to skip before retrieving the next page in the result set. This is used to adjust the starting index of the next page. (Default: 0)
status2stringOPTIONAL: Restricts the search scope to only retrieve tickets whose status matches the specified value. Acceptable values are limited to the following:<br />- INITIALIZED: tickets whose conversation has been started with welcome messages, but when there is no reply from the corresponding customer.<br />- PROACTIVE: tickets whose conversation has been started with proactive messages, but when there is no reply from the corresponding customer.<br />- PENDING: tickets that havent been assigned to any agent yet.<br />- ACTIVE: tickets that are assigned to agents and under the interactions.<br />- CLOSED: closed tickets whose interaction between the agent and customer is ended.<br />- WORK_IN_PROGRESS: tickets that are yet to be closed for any number of reasons but which can be ACTIVE once the conversation between the agent and customer is started.<br />- IDLE: tickets whose customer hasnt replied for a set amount of time after the agents last response.
agentstringOPTIONAL: Specifies the unique ID of an agent to restrict the search scope to only retrieve tickets assigned to a specific agent.
sendbird_idstringOPTIONAL: Restricts the search scope to only retrieve tickets submitted by a customer with a specified Sendbird ID.
qstringOPTIONAL: Restricts the search scope to retrieve up to 100 tickets that match a specified keyword. The specified keyword is applied to the following: channel names, and customers display names and Sendbird IDs. For example, q=cindy retrieves tickets whose channel name, or a customers display name or Sendbird ID includes cindy.
assignment_statusstringOPTIONAL: Restricts the search scope to only retrieve tickets whose assignment status matches the specified value. Acceptable values are limited to the following:<br />- NOT_RESPONDED: tickets whose assignee hasn’t responded yet.<br />- RESPONDED: tickets whose assignee responded.<br />- IDLE: tickets whose assignee responded, but when there is no reply from the corresponding customer for a set amount of time. Once the customer replies, its assignment status will be changed to NOT_RESPONDED.
channel_urlstringOPTIONAL: Restricts the search scope to only retrieve tickets related to a specified channel URL.
start_datestringOPTIONAL: Specifies a starting date that restricts the search scope to retrieve tickets created between start_date and end_date, in YYYY-MM-DD format.
end_datestringOPTIONAL: Specifies an ending date that restricts the search scope to retrieve tickets created between start_date and end_date, in YYYY-MM-DD format.
orderstringOPTIONAL: Specifies the method to sort a list of results. Acceptable values are limited to the following:<br />- id (default): sorts by ticket ID in ascending order.<br />- -id: sorts by ticket ID in descending order.<br />- created_at: sorts by the time of ticket creation in ascending order.<br />- -created_at: sorts by the time of ticket creation in descending order.

HEADERS

KeyDatatypeRequiredDescription
SENDBIRDDESKAPITOKENstring