Unicode C++ / Support API / List Organizations
Back to Collection Items
void ChilkatSample(void)
{
http.put_BasicAuth(true); http.put_Login(L"login"); http.put_Password(L"password"); success = http.QuickGetSb(L"https://example.zendesk.com/api/v2/organizations",sbResponseBody); jResp.LoadSb(sbResponseBody); jResp.put_EmitCompact(false); jResp.put_I(i); created_at = jResp.stringOf(L"organizations[i].created_at"); details = jResp.stringOf(L"organizations[i].details"); external_id = jResp.stringOf(L"organizations[i].external_id"); group_id = jResp.stringOf(L"organizations[i].group_id"); id = jResp.stringOf(L"organizations[i].id"); name = jResp.stringOf(L"organizations[i].name"); notes = jResp.stringOf(L"organizations[i].notes"); Eiusmod_f = jResp.stringOf(L"organizations[i].organization_fields.eiusmod_f"); shared_comments = jResp.stringOf(L"organizations[i].shared_comments"); shared_tickets = jResp.stringOf(L"organizations[i].shared_tickets"); updated_at = jResp.stringOf(L"organizations[i].updated_at"); url = jResp.stringOf(L"organizations[i].url"); Nulla2 = jResp.stringOf(L"organizations[i].organization_fields.nulla2"); j = 0; count_j = jResp.SizeOfArray(L"organizations[i].domain_names"); jResp.put_J(j); strVal = jResp.stringOf(L"organizations[i].domain_names[j]"); j = j + 1; j = 0; count_j = jResp.SizeOfArray(L"organizations[i].tags"); jResp.put_J(j); strVal = jResp.stringOf(L"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}"
}
]
}