List Suspended Tickets
GET {{baseUrl}}/api/v2/suspended_tickets?sort_by=<string>&sort_order=<string>
Allowed For
- Unrestricted agents
Sorting
You can sort the tickets with the sort_by and sort_order query string parameters.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
sort_by | string | The field to sort the ticket by, being one of author_email, cause, created_at, or subject. | |
sort_order | string | The order in which to sort the suspended tickets. This can take value asc or desc. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"suspended_tickets":[{"attachments":[],"author":{"email":"styx@example.com","id":1,"name":"Mr. Roboto"},"brand_id":123,"cause":"Detected as spam","cause_id":0,"content":"Out Of Office Reply","created_at":"2009-07-20T22:55:29Z","error_messages":null,"id":435,"message_id":"Spambot@spam.co.evil","recipient":"john@example.com","subject":"Help, my printer is on fire!","ticket_id":67321,"updated_at":"2011-05-05T10:38:52Z","url":"https://example.zendesk.com/api/v2/tickets/35436.json","via":{"channel":"email","source":{"from":{"address":"totallylegit@emailaddress.com","name":"TotallyLegit"},"rel":null,"to":{"address":"support@example.zendesk.com","name":"Example Account"}}}},{"attachments":[],"author":{"email":"styx@example.com","id":1,"name":"Mr. Roboto"},"brand_id":123,"cause":"Automated response mail","cause_id":0,"content":"Out Of Office Reply","created_at":"2009-07-20T22:55:29Z","error_messages":null,"id":207623,"message_id":"Spambot@spam.co.evil","recipient":"john@example.com","subject":"Not just anybody!","ticket_id":67321,"updated_at":"2011-05-05T10:38:52Z","url":"https://example.zendesk.com/api/v2/tickets/35436.json","via":{"channel":"email","source":{"from":{"address":"totallylegit@emailaddress.com","name":"TotallyLegit"},"rel":null,"to":{"address":"support@example.zendesk.com","name":"Example Account"}}}}]}