C++ / Support API / List Organizations
Back to Collection Items
#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http;
bool success;
http.put_BasicAuth(true);
http.put_Login("login");
http.put_Password("password");
http.SetRequestHeader("Accept","application/json");
CkStringBuilder sbResponseBody;
success = http.QuickGetSb("https://example.zendesk.com/api/v2/organizations",sbResponseBody);
if (success == false) {
std::cout << http.lastErrorText() << "\r\n";
return;
}
CkJsonObject jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
std::cout << "Response Body:" << "\r\n";
std::cout << jResp.emit() << "\r\n";
int respStatusCode = http.get_LastStatus();
std::cout << "Response Status Code = " << respStatusCode << "\r\n";
if (respStatusCode >= 400) {
std::cout << "Response Header:" << "\r\n";
std::cout << http.lastHeader() << "\r\n";
std::cout << "Failed." << "\r\n";
return;
}
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
const char *created_at = 0;
const char *details = 0;
const char *external_id = 0;
const char *group_id = 0;
const char *id = 0;
const char *name = 0;
const char *notes = 0;
const char *Eiusmod_f = 0;
const char *shared_comments = 0;
const char *shared_tickets = 0;
const char *updated_at = 0;
const char *url = 0;
const char *Nulla2 = 0;
int j;
int count_j;
const char *strVal = 0;
const char *count = jResp.stringOf("count");
const char *next_page = jResp.stringOf("next_page");
const char *previous_page = jResp.stringOf("previous_page");
int i = 0;
int 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 -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/organizations
Postman Collection Item JSON
{
"name": "List Organizations",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organizations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations"
]
},
"description": "#### 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\n#### Allowed For\n\n* Agents, with certain restrictions\n\nIf the agent has a custom agent role that restricts their access to only users in their own organization, a 403 Forbidden error is returned. See [Creating custom agent roles](https://support.zendesk.com/hc/en-us/articles/203662026-Creating-custom-roles-and-assigning-agents#topic_cxn_hig_bd) in Zendesk help.\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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organizations"
]
}
},
"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}"
}
]
}
