Foxpro / Support API / List Deleted Users
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcUrl
LOCAL lcName
LOCAL lcEmail
LOCAL lcCreated_at
LOCAL lcUpdated_at
LOCAL lcTime_zone
LOCAL lcPhone
LOCAL lcShared_phone_number
LOCAL lcLocale_id
LOCAL lcLocale
LOCAL lcOrganization_id
LOCAL lcRole
LOCAL lcActive
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
loHttp.SetRequestHeader("Accept","application/json")
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/deleted_users",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* 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
i = 0
lnCount_i = loJResp.SizeOfArray("deleted_users")
DO WHILE i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("deleted_users[i].id")
lcUrl = loJResp.StringOf("deleted_users[i].url")
lcName = loJResp.StringOf("deleted_users[i].name")
lcEmail = loJResp.StringOf("deleted_users[i].email")
lcCreated_at = loJResp.StringOf("deleted_users[i].created_at")
lcUpdated_at = loJResp.StringOf("deleted_users[i].updated_at")
lcTime_zone = loJResp.StringOf("deleted_users[i].time_zone")
lcPhone = loJResp.StringOf("deleted_users[i].phone")
lcShared_phone_number = loJResp.StringOf("deleted_users[i].shared_phone_number")
lcLocale_id = loJResp.StringOf("deleted_users[i].locale_id")
lcLocale = loJResp.StringOf("deleted_users[i].locale")
lcOrganization_id = loJResp.StringOf("deleted_users[i].organization_id")
lcRole = loJResp.StringOf("deleted_users[i].role")
lcActive = loJResp.StringOf("deleted_users[i].active")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
