Retrieve Tickets for Account
GET {{baseUrl}}/tickets?offset=0&pageSize=50&ownerId=UR_8FhxpvCDAz6W&ticketStatus=<integer>&status=<integer>&priority=<integer>&sortBy=<string>&order=asc&allTickets=<boolean>&newFormat=<boolean>
Using the provided query parameters, the API client can filter and retrieve a subset of tickets, instead of the entire collection if desired. <!--From Readme--> <!-- theme: info -->
This API call is only available to organizations that have purchased Closed Loop Follow Up.
This API call will paginate up to a maximum of 10,000 tickets.
To return more than this, use the Search Tickets endpoint with filters that split the tickets into sections of less than 10,000 each.
<!--From Readme--> <!-- theme: info -->
Ticket Priority Mapping
This API will return the Ticket Priority as an integer, 0: Low, 1: Medium, 2:High.
Using the
allTicketsparameterThe
allTicketsparameter is used to specify that tickets for any user in the brand (not just the ones that belong to the authenticated user) should be returned.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
offset | number | The start position for pagination | |
pageSize | number | The maximum number of tickets to return per request | |
ownerId | string | The owner of the ticket | |
ticketStatus | string | A singular ticket status | |
status | string | A singular ticket status | |
priority | string | A singular ticket priority | |
sortBy | string | The attribute to sort results by | |
order | string | The order to sort results by. | |
allTickets | string | A flag for returning all of an organization's tickets, if user is an admin | |
newFormat | string | Flag used to request the new list tickets response format. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"result":{"elements":[{"key":"T-0","name":"\u003cstring\u003e","ownerId":"UR_nFCyhfYhUTO","status":"\u003cinteger\u003e","priority":"\u003cinteger\u003e","followUpDetailsSurveyId":"\u003cstring\u003e","followUpDetailsResponseId":"\u003cstring\u003e"},{"key":"T-4400","name":"\u003cstring\u003e","ownerId":"UR_3BdbDZBSj0g0r52","status":"\u003cinteger\u003e","priority":"\u003cinteger\u003e","followUpDetailsSurveyId":"\u003cstring\u003e","followUpDetailsResponseId":"\u003cstring\u003e"}],"links":{"prev":{"href":"\u003cstring\u003e"},"next":{"href":"\u003cstring\u003e"}}},"meta":{"httpStatus":"\u003cstring\u003e","requestId":"\u003cstring\u003e","notice":"\u003cstring\u003e"}}