List Custom Ticket Statuses
GET {{baseUrl}}/api/v2/custom_statuses?status_categories=<string>&active=<boolean>&default=<boolean>
Lists all undeleted custom ticket statuses for the account. No pagination is provided.
You can't have more than 300 custom ticket statuses at a time.
Allowed For
- End Users
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
status_categories | string | Filter the list of custom ticket statuses by a comma-separated list of status categories | |
active | string | If true, show only active custom ticket statuses. If false, show only inactive custom ticket statuses. If the filter is not used, show all custom ticket statuses | |
default | string | If true, show only default custom ticket statuses. If false, show only non-default custom ticket statuses. If the filter is not used, show all custom ticket statuses |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"custom_statuses":[{"active":true,"agent_label":"Responding quickly","created_at":"2021-07-20T22:55:29.000Z","default":false,"description":"Customer needs a response quickly","end_user_description":"Your ticket is being responded to","end_user_label":"Urgent processing","id":35436,"raw_agent_label":"Responding quickly","raw_description":"Customer needs a response quickly","raw_end_user_description":"Your ticket is being responded to","raw_end_user_label":"Urgent processing","status_category":"open","updated_at":"2021-07-20T22:55:29.000Z"}]}