Perl / Support API / Autocomplete Organizations
Back to Collection Items
use chilkat();
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = chilkat::CkHttp->new();
$http->put_BasicAuth(1);
$http->put_Login("login");
$http->put_Password("password");
$queryParams = chilkat::CkJsonObject->new();
$queryParams->UpdateString("name","<string>");
$queryParams->UpdateString("field_id","<string>");
$queryParams->UpdateString("source","<string>");
$http->SetRequestHeader("Accept","application/json");
# resp is a HttpResponse
$resp = $http->QuickRequestParams("GET","https://example.zendesk.com/api/v2/organizations/autocomplete",$queryParams);
if ($http->get_LastMethodSuccess() == 0) {
print $http->lastErrorText() . "\r\n";
exit;
}
$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);
print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";
$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
print "Response Header:" . "\r\n";
print $resp->header() . "\r\n";
print "Failed." . "\r\n";
exit;
}
# 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");
while ($i < $count_i) {
$jResp->put_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");
while ($j < $count_j) {
$jResp->put_J($j);
$strVal = $jResp->stringOf("organizations[i].domain_names[j]");
$j = $j + 1;
}
$j = 0;
$count_j = $jResp->SizeOfArray("organizations[i].tags");
while ($j < $count_j) {
$jResp->put_J($j);
$strVal = $jResp->stringOf("organizations[i].tags[j]");
$j = $j + 1;
}
$i = $i + 1;
}
Curl Command
curl -u login:password -G -d "name=%3Cstring%3E"
-d "field_id=%3Cstring%3E"
-d "source=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/organizations/autocomplete
Postman Collection Item JSON
{
"name": "Autocomplete Organizations",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organizations/autocomplete?name=<string>&field_id=<string>&source=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
"autocomplete"
],
"query": [
{
"key": "name",
"value": "<string>",
"description": "(Required) A substring of an organization to search for"
},
{
"key": "field_id",
"value": "<string>",
"description": "The id of a lookup relationship field. The type of field is determined\nby the `source` param\n"
},
{
"key": "source",
"value": "<string>",
"description": "If a `field_id` is provided, this specifies the type of the field.\nFor example, if the field is on a \"zen:user\", it references a field on a user\n"
}
]
},
"description": "Returns an array of organizations whose name starts with the\nvalue specified in the `name` parameter.\n\n#### Pagination\n\n* Offset pagination only\n\nSee [Using Offset Pagination](/api-reference/ticketing/introduction/#using-offset-pagination).\n\n#### Allowed For\n\n* Agents\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/autocomplete?name=<string>&field_id=<string>&source=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
"autocomplete"
],
"query": [
{
"key": "name",
"value": "<string>",
"description": "(Required) A substring of an organization to search for"
},
{
"key": "field_id",
"value": "<string>",
"description": "The id of a lookup relationship field. The type of field is determined\nby the `source` param\n"
},
{
"key": "source",
"value": "<string>",
"description": "If a `field_id` is provided, this specifies the type of the field.\nFor example, if the field is on a \"zen:user\", it references a field on a user\n"
}
]
}
},
"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}"
},
{
"name": "Bad request",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organizations/autocomplete?name=<string>&field_id=<string>&source=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
"autocomplete"
],
"query": [
{
"key": "name",
"value": "<string>",
"description": "(Required) A substring of an organization to search for"
},
{
"key": "field_id",
"value": "<string>",
"description": "The id of a lookup relationship field. The type of field is determined\nby the `source` param\n"
},
{
"key": "source",
"value": "<string>",
"description": "If a `field_id` is provided, this specifies the type of the field.\nFor example, if the field is on a \"zen:user\", it references a field on a user\n"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organizations/autocomplete?name=<string>&field_id=<string>&source=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
"autocomplete"
],
"query": [
{
"key": "name",
"value": "<string>",
"description": "(Required) A substring of an organization to search for"
},
{
"key": "field_id",
"value": "<string>",
"description": "The id of a lookup relationship field. The type of field is determined\nby the `source` param\n"
},
{
"key": "source",
"value": "<string>",
"description": "If a `field_id` is provided, this specifies the type of the field.\nFor example, if the field is on a \"zen:user\", it references a field on a user\n"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Internal Server Error",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organizations/autocomplete?name=<string>&field_id=<string>&source=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations",
"autocomplete"
],
"query": [
{
"key": "name",
"value": "<string>",
"description": "(Required) A substring of an organization to search for"
},
{
"key": "field_id",
"value": "<string>",
"description": "The id of a lookup relationship field. The type of field is determined\nby the `source` param\n"
},
{
"key": "source",
"value": "<string>",
"description": "If a `field_id` is provided, this specifies the type of the field.\nFor example, if the field is on a \"zen:user\", it references a field on a user\n"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n }\n ]\n}"
}
]
}
