PHP (Extension) / Support API / List Groups
Back to Collection Items
<?php
include("chilkat_9_5_0.php");
$http->put_BasicAuth(true);$http->put_Login('login');$http->put_Password('password');$success = $http->QuickGetSb('https://example.zendesk.com/api/v2/groups',$sbResponseBody);$jResp->LoadSb($sbResponseBody);$jResp->put_EmitCompact(false);$jResp->put_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
Postman Collection Item JSON
{
"name": "List Groups",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"groups"
],
"variable": [
{
"key": "user_id",
"value": "<integer>",
"description": "(Required) The id of the user"
},
{
"key": "exclude_deleted",
"value": "<boolean>",
"description": "Whether to exclude deleted entities"
}
]
},
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"groups"
]
}
},
"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}"
}
]
}