PHP (Extension) / Support API / List Deleted Users
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/deleted_users',$sbResponseBody);$jResp->LoadSb($sbResponseBody);$jResp->put_EmitCompact(false);$jResp->put_I($i);$id = $jResp->stringOf('deleted_users[i].id');$url = $jResp->stringOf('deleted_users[i].url');$name = $jResp->stringOf('deleted_users[i].name');$email = $jResp->stringOf('deleted_users[i].email');$created_at = $jResp->stringOf('deleted_users[i].created_at');$updated_at = $jResp->stringOf('deleted_users[i].updated_at');$time_zone = $jResp->stringOf('deleted_users[i].time_zone');$phone = $jResp->stringOf('deleted_users[i].phone');$shared_phone_number = $jResp->stringOf('deleted_users[i].shared_phone_number');$locale_id = $jResp->stringOf('deleted_users[i].locale_id');$locale = $jResp->stringOf('deleted_users[i].locale');$organization_id = $jResp->stringOf('deleted_users[i].organization_id');$role = $jResp->stringOf('deleted_users[i].role');$active = $jResp->stringOf('deleted_users[i].active');$i = $i + 1;
?>
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/deleted_users
Postman Collection Item JSON
{
"name": "List Deleted Users",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/deleted_users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"deleted_users"
]
},
"description": "Returns deleted users, including permanently deleted users.\n\nIf the results contains permanently deleted users, the users' properties\nthat normally contain personal data, such as `email` and `phone`,\nare null. The `name` property is \"Permanently Deleted User\".\n\n#### 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\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/deleted_users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"deleted_users"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"deleted_users\": [\n {\n \"id\": \"<integer>\",\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"<null>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"phone\": \"<string>\",\n \"shared_phone_number\": \"<string>\",\n \"photo\": {},\n \"locale_id\": \"<integer>\",\n \"locale\": \"<string>\",\n \"organization_id\": \"<null>\",\n \"role\": \"<string>\",\n \"active\": \"<boolean>\"\n },\n {\n \"id\": \"<integer>\",\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"<null>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"phone\": \"<string>\",\n \"shared_phone_number\": \"<string>\",\n \"photo\": {},\n \"locale_id\": \"<integer>\",\n \"locale\": \"<string>\",\n \"organization_id\": \"<null>\",\n \"role\": \"<string>\",\n \"active\": \"<boolean>\"\n }\n ]\n}"
}
]
}