Chilkat Online Tools

Powershell / Support API / List Deleted Users

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = New-Object Chilkat.Http

$http.BasicAuth = $true
$http.Login = "login"
$http.Password = "password"

$http.SetRequestHeader("Accept","application/json")

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://example.zendesk.com/api/v2/deleted_users",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($http.LastHeader)
    $("Failed.")
    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

$i = 0
$count_i = $jResp.SizeOfArray("deleted_users")
while ($i -lt $count_i) {
    $jResp.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}"
    }
  ]
}