List Deleted Users
GET {{baseUrl}}/api/v2/deleted_users
Returns deleted users, including permanently deleted users.
If the results contains permanently deleted users, the users' properties
that normally contain personal data, such as email
and phone
,
are null. The name
property is Permanently Deleted User
.
Pagination
- Cursor pagination (recommended)
- Offset pagination
See Pagination.
Returns a maximum of 100 records per page.
Allowed For
- Agents
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"deleted_users":[{"active":false,"created_at":"2019-08-26T02:10:24Z","email":null,"id":189304711533,"locale":"en-US","locale_id":1,"name":"David","organization_id":null,"phone":null,"photo":null,"role":"end-user","shared_phone_number":null,"time_zone":"Eastern Time (US \u0026 Canada)","updated_at":"2019-08-26T02:10:27Z","url":"https://{subdomain}.zendesk.com/api/v2/deleted_users/189304711533"},{"active":false,"created_at":"2019-08-26T02:10:28Z","email":null,"id":12204720593,"locale":"en-US","locale_id":1,"name":"Linda","organization_id":null,"phone":null,"photo":null,"role":"end-user","shared_phone_number":null,"time_zone":"Eastern Time (US \u0026 Canada)","updated_at":"2019-08-26T02:10:29Z","url":"https://{subdomain}.zendesk.com/api/v2/deleted_users/12204720593"}]}