Chilkat Tools

C# / Support API / List Organizations

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Chilkat.Http http = new Chilkat.Http();
bool success;

http.BasicAuth = true;
http.Login = "login";
http.Password = "password";

http.SetRequestHeader("Accept","application/json");

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://example.zendesk.com/api/v2/organizations",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    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

string created_at;
string details;
string external_id;
string group_id;
string id;
string name;
string notes;
string Eiusmod_f;
string shared_comments;
string shared_tickets;
string updated_at;
string url;
string Nulla2;
int j;
int count_j;
string strVal;

string count = jResp.StringOf("count");
string next_page = jResp.StringOf("next_page");
string previous_page = jResp.StringOf("previous_page");
int i = 0;
int count_i = jResp.SizeOfArray("organizations");
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");
    while (j < count_j) {
        jResp.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.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}"
    }
  ]
}

Chilkat Online Tools

C# / Support API / List Organizations

Curl Command

Postman Collection Item JSON