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

KeyDatatypeRequiredDescription
status_categoriesstringFilter the list of custom ticket statuses by a comma-separated list of status categories
activestringIf 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
defaultstringIf 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

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;custom_statuses&quot;:[{&quot;active&quot;:true,&quot;agent_label&quot;:&quot;Responding quickly&quot;,&quot;created_at&quot;:&quot;2021-07-20T22:55:29.000Z&quot;,&quot;default&quot;:false,&quot;description&quot;:&quot;Customer needs a response quickly&quot;,&quot;end_user_description&quot;:&quot;Your ticket is being responded to&quot;,&quot;end_user_label&quot;:&quot;Urgent processing&quot;,&quot;id&quot;:35436,&quot;raw_agent_label&quot;:&quot;Responding quickly&quot;,&quot;raw_description&quot;:&quot;Customer needs a response quickly&quot;,&quot;raw_end_user_description&quot;:&quot;Your ticket is being responded to&quot;,&quot;raw_end_user_label&quot;:&quot;Urgent processing&quot;,&quot;status_category&quot;:&quot;open&quot;,&quot;updated_at&quot;:&quot;2021-07-20T22:55:29.000Z&quot;}]}