Go / Support API / List Automations
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global_Ref.html">Global Unlock Sample for sample code.
http := chilkat.NewHttp()
var success bool
http.SetBasicAuth(true)
http.SetLogin("login")
http.SetPassword("password")
http.SetRequestHeader("Accept","application/json")
sbResponseBody := chilkat.NewStringBuilder()
success = http.QuickGetSb("https://example.zendesk.com/api/v2/automations",sbResponseBody)
if success == false {
fmt.Println(http.LastErrorText())
http.DisposeHttp()
sbResponseBody.DisposeStringBuilder()
return
}
jResp := chilkat.NewJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.SetEmitCompact(false)
fmt.Println("Response Body:")
fmt.Println(*jResp.Emit())
respStatusCode := http.LastStatus()
fmt.Println("Response Status Code = ", respStatusCode)
if respStatusCode >= 400 {
fmt.Println("Response Header:")
fmt.Println(http.LastHeader())
fmt.Println("Failed.")
http.DisposeHttp()
sbResponseBody.DisposeStringBuilder()
jResp.DisposeJsonObject()
return
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "automations": [
// {
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "active": "<boolean>",
// "conditions": {
// "all": [
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// }
// ],
// "any": [
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// }
// ]
// },
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "id": "<integer>",
// "position": "<integer>",
// "raw_title": "<string>",
// "title": "<string>",
// "updated_at": "<dateTime>"
// },
// {
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "active": "<boolean>",
// "conditions": {
// "all": [
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// }
// ],
// "any": [
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// }
// ]
// },
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "id": "<integer>",
// "position": "<integer>",
// "raw_title": "<string>",
// "title": "<string>",
// "updated_at": "<dateTime>"
// }
// ],
// "count": "<integer>",
// "next_page": "<string>",
// "previous_page": "<string>"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var active *string = new(string)
var created_at *string = new(string)
var default *string = new(string)
var id *string = new(string)
var position *string = new(string)
raw_ var title *string = new(string)
var title *string = new(string)
var updated_at *string = new(string)
var j int
var count_j int
var field *string = new(string)
var value *string = new(string)
var operator *string = new(string)
count := jResp.StringOf("count")
next_page := jResp.StringOf("next_page")
previous_page := jResp.StringOf("previous_page")
i := 0
count_i := jResp.SizeOfArray("automations")
for i < count_i {
jResp.SetI(i)
active = jResp.StringOf("automations[i].active")
created_at = jResp.StringOf("automations[i].created_at")
default = jResp.StringOf("automations[i].default")
id = jResp.StringOf("automations[i].id")
position = jResp.StringOf("automations[i].position")
raw_title = jResp.StringOf("automations[i].raw_title")
title = jResp.StringOf("automations[i].title")
updated_at = jResp.StringOf("automations[i].updated_at")
j = 0
count_j = jResp.SizeOfArray("automations[i].actions")
for j < count_j {
jResp.SetJ(j)
field = jResp.StringOf("automations[i].actions[j].field")
value = jResp.StringOf("automations[i].actions[j].value")
j = j + 1
}
j = 0
count_j = jResp.SizeOfArray("automations[i].conditions.all")
for j < count_j {
jResp.SetJ(j)
field = jResp.StringOf("automations[i].conditions.all[j].field")
operator = jResp.StringOf("automations[i].conditions.all[j].operator")
value = jResp.StringOf("automations[i].conditions.all[j].value")
j = j + 1
}
j = 0
count_j = jResp.SizeOfArray("automations[i].conditions.any")
for j < count_j {
jResp.SetJ(j)
field = jResp.StringOf("automations[i].conditions.any[j].field")
operator = jResp.StringOf("automations[i].conditions.any[j].operator")
value = jResp.StringOf("automations[i].conditions.any[j].value")
j = j + 1
}
i = i + 1
}
http.DisposeHttp()
sbResponseBody.DisposeStringBuilder()
jResp.DisposeJsonObject()
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/automations
Postman Collection Item JSON
{
"name": "List Automations",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/automations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"automations"
]
},
"description": "Lists all automations for the current account.\n\n#### Allowed For\n\n* Agents\n\n#### Available Parameters\n\nYou can pass in any combination of the following optional filters:\n\n| Name | Type | Comment\n| ---------- | ------- | -------\n| active | boolean | Only active automations if true, inactive automations if false\n| sort_by | string | Possible values are \"alphabetical\", \"created_at\", \"updated_at\", \"usage_1h\", \"usage_24h\", or \"usage_7d\". Defaults to \"position\"\n| sort_order | string | One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others\n\n#### Sideloads\n\nThe following sideloads are supported. The usage sideloads are only supported on the Support Professional or Suite Growth plan or above.\n\n| Name | Will sideload\n| ---------------- | -------------\n| app_installation | The app installation that requires each automation, if present\n| permissions | The permissions for each automation\n| usage_1h | The number of times each automation has been used in the past hour\n| usage_24h | The number of times each automation has been used in the past day\n| usage_7d | The number of times each automation has been used in the past week\n| usage_30d | The number of times each automation has been used in the past thirty days\n\n#### Pagination\n\n- Cursor pagination (recommended)\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/automations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"automations"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"automations\": [\n {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"active\": \"<boolean>\",\n \"conditions\": {\n \"all\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"any\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_title\": \"<string>\",\n \"title\": \"<string>\",\n \"updated_at\": \"<dateTime>\"\n },\n {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"active\": \"<boolean>\",\n \"conditions\": {\n \"all\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"any\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_title\": \"<string>\",\n \"title\": \"<string>\",\n \"updated_at\": \"<dateTime>\"\n }\n ],\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\"\n}"
}
]
}
