autoit / Support API / List Custom Ticket Statuses
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"
$oQueryParams = ObjCreate("Chilkat_9_5_0.JsonObject")
$oQueryParams.UpdateString("status_categories","<string>")
$oQueryParams.UpdateString("active","<boolean>")
$oQueryParams.UpdateString("default","<boolean>")
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequestParams("GET","https://example.zendesk.com/api/v2/custom_statuses",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "custom_statuses": [
; {
; "status_category": "pending",
; "agent_label": "<string>",
; "active": "<boolean>",
; "created_at": "<dateTime>",
; "default": "<boolean>",
; "description": "<string>",
; "end_user_description": "<string>",
; "end_user_label": "<string>",
; "id": "<integer>",
; "raw_agent_label": "<string>",
; "raw_description": "<string>",
; "raw_end_user_description": "<string>",
; "raw_end_user_label": "<string>",
; "updated_at": "<dateTime>"
; },
; {
; "status_category": "hold",
; "agent_label": "<string>",
; "active": "<boolean>",
; "created_at": "<dateTime>",
; "default": "<boolean>",
; "description": "<string>",
; "end_user_description": "<string>",
; "end_user_label": "<string>",
; "id": "<integer>",
; "raw_agent_label": "<string>",
; "raw_description": "<string>",
; "raw_end_user_description": "<string>",
; "raw_end_user_label": "<string>",
; "updated_at": "<dateTime>"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $status_category
Local $sAgent_label
Local $sActive
Local $sCreated_at
Local $sDefault
Local $sDescription
Local $sEnd_user_description
Local $sEnd_user_label
Local $sId
Local $sRaw_agent_label
Local $sRaw_description
Local $sRaw_end_user_description
Local $sRaw_end_user_label
Local $sUpdated_at
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("custom_statuses")
While $i < $iCount_i
$oJResp.I = $i
$status_category = $oJResp.StringOf("custom_statuses[i].status_category")
$sAgent_label = $oJResp.StringOf("custom_statuses[i].agent_label")
$sActive = $oJResp.StringOf("custom_statuses[i].active")
$sCreated_at = $oJResp.StringOf("custom_statuses[i].created_at")
$sDefault = $oJResp.StringOf("custom_statuses[i].default")
$sDescription = $oJResp.StringOf("custom_statuses[i].description")
$sEnd_user_description = $oJResp.StringOf("custom_statuses[i].end_user_description")
$sEnd_user_label = $oJResp.StringOf("custom_statuses[i].end_user_label")
$sId = $oJResp.StringOf("custom_statuses[i].id")
$sRaw_agent_label = $oJResp.StringOf("custom_statuses[i].raw_agent_label")
$sRaw_description = $oJResp.StringOf("custom_statuses[i].raw_description")
$sRaw_end_user_description = $oJResp.StringOf("custom_statuses[i].raw_end_user_description")
$sRaw_end_user_label = $oJResp.StringOf("custom_statuses[i].raw_end_user_label")
$sUpdated_at = $oJResp.StringOf("custom_statuses[i].updated_at")
$i = $i + 1
Wend
Curl Command
curl -u login:password -G -d "status_categories=%3Cstring%3E"
-d "active=%3Cboolean%3E"
-d "default=%3Cboolean%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/custom_statuses
Postman Collection Item JSON
{
"name": "List Custom Ticket Statuses",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/custom_statuses?status_categories=<string>&active=<boolean>&default=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_statuses"
],
"query": [
{
"key": "status_categories",
"value": "<string>",
"description": "Filter the list of custom ticket statuses by a comma-separated list of status categories"
},
{
"key": "active",
"value": "<boolean>",
"description": "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"
},
{
"key": "default",
"value": "<boolean>",
"description": "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"
}
]
},
"description": "Lists all undeleted custom ticket statuses for the account. No pagination is provided.\n\n#### Allowed For\n\n* End Users\n"
},
"response": [
{
"name": "List custom ticket statuses",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/custom_statuses?status_categories=<string>&active=<boolean>&default=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_statuses"
],
"query": [
{
"key": "status_categories",
"value": "<string>",
"description": "Filter the list of custom ticket statuses by a comma-separated list of status categories"
},
{
"key": "active",
"value": "<boolean>",
"description": "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"
},
{
"key": "default",
"value": "<boolean>",
"description": "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"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"custom_statuses\": [\n {\n \"status_category\": \"pending\",\n \"agent_label\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"end_user_description\": \"<string>\",\n \"end_user_label\": \"<string>\",\n \"id\": \"<integer>\",\n \"raw_agent_label\": \"<string>\",\n \"raw_description\": \"<string>\",\n \"raw_end_user_description\": \"<string>\",\n \"raw_end_user_label\": \"<string>\",\n \"updated_at\": \"<dateTime>\"\n },\n {\n \"status_category\": \"hold\",\n \"agent_label\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"end_user_description\": \"<string>\",\n \"end_user_label\": \"<string>\",\n \"id\": \"<integer>\",\n \"raw_agent_label\": \"<string>\",\n \"raw_description\": \"<string>\",\n \"raw_end_user_description\": \"<string>\",\n \"raw_end_user_label\": \"<string>\",\n \"updated_at\": \"<dateTime>\"\n }\n ]\n}"
}
]
}
