VBScript / Support API / Search Organizations by External ID
Back to Collection Items
Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")
http.BasicAuth = 1
http.Login = "login"
http.Password = "password"
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set queryParams = CreateObject("Chilkat.JsonObject")
success = queryParams.UpdateString("external_id","<integer>")
http.SetRequestHeader "Accept","application/json"
' resp is a Chilkat.HttpResponse
Set resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/organizations/search",queryParams)
If (http.LastMethodSuccess = 0) Then
outFile.WriteLine(http.LastErrorText)
WScript.Quit
End If
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())
respStatusCode = resp.StatusCode
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
outFile.WriteLine("Response Header:")
outFile.WriteLine(resp.Header)
outFile.WriteLine("Failed.")
WScript.Quit
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "count": "<integer>",
' "next_page": "<string>",
' "organizations": [
' {
' "created_at": "<string>",
' "details": "<string>",
' "domain_names": [
' "<string>",
' "<string>"
' ],
' "external_id": "<string>",
' "group_id": "<integer>",
' "id": "<integer>",
' "name": "<string>",
' "notes": "<string>",
' "organization_fields": {
' "eiusmod_f": "<string>"
' },
' "shared_comments": "<boolean>",
' "shared_tickets": "<boolean>",
' "tags": [
' "<string>",
' "<string>"
' ],
' "updated_at": "<string>",
' "url": "<string>"
' },
' {
' "created_at": "<string>",
' "details": "<string>",
' "domain_names": [
' "<string>",
' "<string>"
' ],
' "external_id": "<string>",
' "group_id": "<integer>",
' "id": "<integer>",
' "name": "<string>",
' "notes": "<string>",
' "organization_fields": {
' "nulla2": "<string>"
' },
' "shared_comments": "<boolean>",
' "shared_tickets": "<boolean>",
' "tags": [
' "<string>",
' "<string>"
' ],
' "updated_at": "<string>",
' "url": "<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
count = jResp.StringOf("count")
next_page = jResp.StringOf("next_page")
previous_page = jResp.StringOf("previous_page")
i = 0
count_i = jResp.SizeOfArray("organizations")
Do While i < count_i
jResp.I = i
created_at = jResp.StringOf("organizations[i].created_at")
details = jResp.StringOf("organizations[i].details")
external_id = jResp.StringOf("organizations[i].external_id")
group_id = jResp.StringOf("organizations[i].group_id")
id = jResp.StringOf("organizations[i].id")
name = jResp.StringOf("organizations[i].name")
notes = jResp.StringOf("organizations[i].notes")
Eiusmod_f = jResp.StringOf("organizations[i].organization_fields.eiusmod_f")
shared_comments = jResp.StringOf("organizations[i].shared_comments")
shared_tickets = jResp.StringOf("organizations[i].shared_tickets")
updated_at = jResp.StringOf("organizations[i].updated_at")
url = jResp.StringOf("organizations[i].url")
Nulla2 = jResp.StringOf("organizations[i].organization_fields.nulla2")
j = 0
count_j = jResp.SizeOfArray("organizations[i].domain_names")
Do While j < count_j
jResp.J = j
strVal = jResp.StringOf("organizations[i].domain_names[j]")
j = j + 1
Loop
j = 0
count_j = jResp.SizeOfArray("organizations[i].tags")
Do While j < count_j
jResp.J = j
strVal = jResp.StringOf("organizations[i].tags[j]")
j = j + 1
Loop
i = i + 1
Loop
outFile.Close
Curl Command
curl -u login:password -G -d "external_id=%3Cinteger%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/organizations/search
Postman Collection Item JSON
{
"name": "Search Organizations by External ID",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organizations/search?external_id=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
"search"
],
"query": [
{
"key": "external_id",
"value": "<integer>",
"description": "(Required) The external id of an organization"
}
]
},
"description": "If you set the `external_id` value of an organization to associate it to an external record, you can use the external id to search for the organization.\n\n#### Allowed For:\n\n* Admins\n* Agents assigned to a custom role with permissions to add or modify organizations (Enterprise only)\n\nSee [Creating custom agent roles](https://support.zendesk.com/hc/en-us/articles/203662026#topic_cxn_hig_bd) in the Support Help Center.\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/organizations/search?external_id=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
"search"
],
"query": [
{
"key": "external_id",
"value": "<integer>",
"description": "(Required) The external id of an organization"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"organizations\": [\n {\n \"created_at\": \"<string>\",\n \"details\": \"<string>\",\n \"domain_names\": [\n \"<string>\",\n \"<string>\"\n ],\n \"external_id\": \"<string>\",\n \"group_id\": \"<integer>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"organization_fields\": {\n \"eiusmod_f\": \"<string>\"\n },\n \"shared_comments\": \"<boolean>\",\n \"shared_tickets\": \"<boolean>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"created_at\": \"<string>\",\n \"details\": \"<string>\",\n \"domain_names\": [\n \"<string>\",\n \"<string>\"\n ],\n \"external_id\": \"<string>\",\n \"group_id\": \"<integer>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"organization_fields\": {\n \"nulla2\": \"<string>\"\n },\n \"shared_comments\": \"<boolean>\",\n \"shared_tickets\": \"<boolean>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"previous_page\": \"<string>\"\n}"
}
]
}
