C / Support API / List Deleted Users
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *id;
const char *url;
const char *name;
const char *email;
const char *created_at;
const char *updated_at;
const char *time_zone;
const char *phone;
const char *shared_phone_number;
const char *locale_id;
const char *locale;
const char *organization_id;
const char *role;
const char *active;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
CkHttp_putBasicAuth(http,TRUE);
CkHttp_putLogin(http,"login");
CkHttp_putPassword(http,"password");
CkHttp_SetRequestHeader(http,"Accept","application/json");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://example.zendesk.com/api/v2/deleted_users",sbResponseBody);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"deleted_users");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
id = CkJsonObject_stringOf(jResp,"deleted_users[i].id");
url = CkJsonObject_stringOf(jResp,"deleted_users[i].url");
name = CkJsonObject_stringOf(jResp,"deleted_users[i].name");
email = CkJsonObject_stringOf(jResp,"deleted_users[i].email");
created_at = CkJsonObject_stringOf(jResp,"deleted_users[i].created_at");
updated_at = CkJsonObject_stringOf(jResp,"deleted_users[i].updated_at");
time_zone = CkJsonObject_stringOf(jResp,"deleted_users[i].time_zone");
phone = CkJsonObject_stringOf(jResp,"deleted_users[i].phone");
shared_phone_number = CkJsonObject_stringOf(jResp,"deleted_users[i].shared_phone_number");
locale_id = CkJsonObject_stringOf(jResp,"deleted_users[i].locale_id");
locale = CkJsonObject_stringOf(jResp,"deleted_users[i].locale");
organization_id = CkJsonObject_stringOf(jResp,"deleted_users[i].organization_id");
role = CkJsonObject_stringOf(jResp,"deleted_users[i].role");
active = CkJsonObject_stringOf(jResp,"deleted_users[i].active");
i = i + 1;
}
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(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}"
}
]
}