Foxpro / Support API / Search Organizations by External ID
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCreated_at
LOCAL lcDetails
LOCAL lcExternal_id
LOCAL lcGroup_id
LOCAL lcId
LOCAL lcName
LOCAL lcNotes
LOCAL lcEiusmod_f
LOCAL lcShared_comments
LOCAL lcShared_tickets
LOCAL lcUpdated_at
LOCAL lcUrl
LOCAL lcNulla2
LOCAL j
LOCAL lnCount_j
LOCAL lcStrVal
LOCAL lcCount
LOCAL lcNext_page
LOCAL lcPrevious_page
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
loQueryParams = CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams.UpdateString("external_id","<integer>")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://example.zendesk.com/api/v2/organizations/search",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcCount = loJResp.StringOf("count")
lcNext_page = loJResp.StringOf("next_page")
lcPrevious_page = loJResp.StringOf("previous_page")
i = 0
lnCount_i = loJResp.SizeOfArray("organizations")
DO WHILE i < lnCount_i
loJResp.I = i
lcCreated_at = loJResp.StringOf("organizations[i].created_at")
lcDetails = loJResp.StringOf("organizations[i].details")
lcExternal_id = loJResp.StringOf("organizations[i].external_id")
lcGroup_id = loJResp.StringOf("organizations[i].group_id")
lcId = loJResp.StringOf("organizations[i].id")
lcName = loJResp.StringOf("organizations[i].name")
lcNotes = loJResp.StringOf("organizations[i].notes")
lcEiusmod_f = loJResp.StringOf("organizations[i].organization_fields.eiusmod_f")
lcShared_comments = loJResp.StringOf("organizations[i].shared_comments")
lcShared_tickets = loJResp.StringOf("organizations[i].shared_tickets")
lcUpdated_at = loJResp.StringOf("organizations[i].updated_at")
lcUrl = loJResp.StringOf("organizations[i].url")
lcNulla2 = loJResp.StringOf("organizations[i].organization_fields.nulla2")
j = 0
lnCount_j = loJResp.SizeOfArray("organizations[i].domain_names")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("organizations[i].domain_names[j]")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("organizations[i].tags")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("organizations[i].tags[j]")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
