Chilkat Online Tools

phpAx / Support API / List Assignable Groups

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

$http->BasicAuth = 1;
$http->Login = 'login';
$http->Password = 'password';

$http->SetRequestHeader('Accept','application/json');

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$success = $http->QuickGetSb('https://example.zendesk.com/api/v2/groups/assignable',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->LastHeader . "\n";
    print 'Failed.' . "\n";
    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "groups": [
//     {
//       "name": "<string>",
//       "created_at": "<dateTime>",
//       "default": "<boolean>",
//       "deleted": "<boolean>",
//       "description": "<string>",
//       "id": "<integer>",
//       "is_public": "<boolean>",
//       "updated_at": "<dateTime>",
//       "url": "<string>"
//     },
//     {
//       "name": "<string>",
//       "created_at": "<dateTime>",
//       "default": "<boolean>",
//       "deleted": "<boolean>",
//       "description": "<string>",
//       "id": "<integer>",
//       "is_public": "<boolean>",
//       "updated_at": "<dateTime>",
//       "url": "<string>"
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$i = 0;
$count_i = $jResp->SizeOfArray('groups');
while ($i < $count_i) {
    $jResp->I = $i;
    $name = $jResp->stringOf('groups[i].name');
    $created_at = $jResp->stringOf('groups[i].created_at');
    $default = $jResp->stringOf('groups[i].default');
    $deleted = $jResp->stringOf('groups[i].deleted');
    $description = $jResp->stringOf('groups[i].description');
    $id = $jResp->stringOf('groups[i].id');
    $is_public = $jResp->stringOf('groups[i].is_public');
    $updated_at = $jResp->stringOf('groups[i].updated_at');
    $url = $jResp->stringOf('groups[i].url');
    $i = $i + 1;
}


?>

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/groups/assignable

Postman Collection Item JSON

{
  "name": "List Assignable Groups",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/groups/assignable",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "groups",
        "assignable"
      ]
    },
    "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* Admins\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/groups/assignable",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "groups",
            "assignable"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"groups\": [\n    {\n      \"name\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"deleted\": \"<boolean>\",\n      \"description\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"is_public\": \"<boolean>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"name\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"deleted\": \"<boolean>\",\n      \"description\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"is_public\": \"<boolean>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}