autoit / Support API / List Deleted Users
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"
$oHttp.SetRequestHeader "Accept","application/json"
$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/deleted_users",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
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
Local $sId
Local $sUrl
Local $sName
Local $sEmail
Local $sCreated_at
Local $sUpdated_at
Local $sTime_zone
Local $sPhone
Local $shared_phone_number
Local $sLocale_id
Local $sLocale
Local $sOrganization_id
Local $sRole
Local $sActive
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("deleted_users")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("deleted_users[i].id")
$sUrl = $oJResp.StringOf("deleted_users[i].url")
$sName = $oJResp.StringOf("deleted_users[i].name")
$sEmail = $oJResp.StringOf("deleted_users[i].email")
$sCreated_at = $oJResp.StringOf("deleted_users[i].created_at")
$sUpdated_at = $oJResp.StringOf("deleted_users[i].updated_at")
$sTime_zone = $oJResp.StringOf("deleted_users[i].time_zone")
$sPhone = $oJResp.StringOf("deleted_users[i].phone")
$shared_phone_number = $oJResp.StringOf("deleted_users[i].shared_phone_number")
$sLocale_id = $oJResp.StringOf("deleted_users[i].locale_id")
$sLocale = $oJResp.StringOf("deleted_users[i].locale")
$sOrganization_id = $oJResp.StringOf("deleted_users[i].organization_id")
$sRole = $oJResp.StringOf("deleted_users[i].role")
$sActive = $oJResp.StringOf("deleted_users[i].active")
$i = $i + 1
Wend
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}"
}
]
}
