TCL / Support API / List Deleted Users
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://example.zendesk.com/api/v2/deleted_users" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "deleted_users": [
# {
# "id": "<integer>",
# "url": "<string>",
# "name": "<string>",
# "email": "<null>",
# "created_at": "<string>",
# "updated_at": "<string>",
# "time_zone": "<string>",
# "phone": "<string>",
# "shared_phone_number": "<string>",
# "photo": {},
# "locale_id": "<integer>",
# "locale": "<string>",
# "organization_id": "<null>",
# "role": "<string>",
# "active": "<boolean>"
# },
# {
# "id": "<integer>",
# "url": "<string>",
# "name": "<string>",
# "email": "<null>",
# "created_at": "<string>",
# "updated_at": "<string>",
# "time_zone": "<string>",
# "phone": "<string>",
# "shared_phone_number": "<string>",
# "photo": {},
# "locale_id": "<integer>",
# "locale": "<string>",
# "organization_id": "<null>",
# "role": "<string>",
# "active": "<boolean>"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "deleted_users"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_stringOf $jResp "deleted_users[i].id"]
set url [CkJsonObject_stringOf $jResp "deleted_users[i].url"]
set name [CkJsonObject_stringOf $jResp "deleted_users[i].name"]
set email [CkJsonObject_stringOf $jResp "deleted_users[i].email"]
set created_at [CkJsonObject_stringOf $jResp "deleted_users[i].created_at"]
set updated_at [CkJsonObject_stringOf $jResp "deleted_users[i].updated_at"]
set time_zone [CkJsonObject_stringOf $jResp "deleted_users[i].time_zone"]
set phone [CkJsonObject_stringOf $jResp "deleted_users[i].phone"]
set shared_phone_number [CkJsonObject_stringOf $jResp "deleted_users[i].shared_phone_number"]
set locale_id [CkJsonObject_stringOf $jResp "deleted_users[i].locale_id"]
set locale [CkJsonObject_stringOf $jResp "deleted_users[i].locale"]
set organization_id [CkJsonObject_stringOf $jResp "deleted_users[i].organization_id"]
set role [CkJsonObject_stringOf $jResp "deleted_users[i].role"]
set active [CkJsonObject_stringOf $jResp "deleted_users[i].active"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}