Delphi (DLL) / Support API / Count Users
Back to Collection Items
var
begin
CkHttp_putBasicAuth(http,True);CkHttp_putLogin(http,'login');CkHttp_putPassword(http,'password');CkJsonObject_UpdateString(queryParams,'role','end-user');CkJsonObject_UpdateString(queryParams,'role[]','<string>');CkJsonObject_UpdateString(queryParams,'permission_set','<integer>');CkHttpResponse_GetBodySb(resp,sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);
Curl Command
curl -u login:password -G -d "role=end-user"
-d "role[]=%3Cstring%3E"
-d "permission_set=%3Cinteger%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/count
Postman Collection Item JSON
{
"name": "Count Users",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/count?role=end-user&role[]=<string>&permission_set=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"count"
],
"query": [
{
"key": "role",
"value": "end-user",
"description": "Filters the results by role. Possible values are \"end-user\", \"agent\", or \"admin\"\n"
},
{
"key": "role[]",
"value": "<string>",
"description": "Filters the results by more than one role using the format `role[]={role}&role[]={role}`\n"
},
{
"key": "permission_set",
"value": "<integer>",
"description": "For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request"
}
]
},
"description": "Returns an approximate count of users. If the count exceeds 100,000, it is updated every 24 hours.\n\nThe response includes a `refreshed_at` property in a `count` object that contains a timestamp indicating when the count was last updated.\n\n**Note**: When the count exceeds 100,000, the `refreshed_at` property may occasionally be null.\nThis indicates that the count is being updated in the background. The `count` object's `value` property is limited to 100,000 until the update is complete.\n\n#### Allowed For\n\n* Admins, Agents and Light 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/users/count?role=end-user&role[]=<string>&permission_set=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"count"
],
"query": [
{
"key": "role",
"value": "end-user",
"description": "Filters the results by role. Possible values are \"end-user\", \"agent\", or \"admin\"\n"
},
{
"key": "role[]",
"value": "<string>",
"description": "Filters the results by more than one role using the format `role[]={role}&role[]={role}`\n"
},
{
"key": "permission_set",
"value": "<integer>",
"description": "For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": {\n \"refreshed_at\": \"<string>\",\n \"value\": \"<integer>\"\n }\n}"
}
]
}