---
title: "List Deleted Users"
method: GET
path: "/api/v2/deleted_users"
tags: ["Users"]
---

# List Deleted Users

`GET /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](/api-reference/introduction/pagination/).

Returns a maximum of 100 records per page.

#### Allowed For

* Agents

## Query parameters

- `page[before]` string
- `page[after]` string
- `page[size]` integer

## Response `200`

Success response

- DeletedUsersResponse
  - `deleted_users` DeletedUserObject[]
    - `active` boolean, required
    - `created_at` string, required
    - `email` string, required
    - `id` integer, required
    - `locale` string, required
    - `locale_id` integer, required
    - `name` string, required
    - `organization_id` integer, required
    - `phone` string, nullable, required
    - `photo` object, nullable, required
    - `role` string, required
    - `shared_phone_number` string, nullable, required
    - `time_zone` string, required
    - `updated_at` string, required
    - `url` string, required

---

[API](https://skmtc.net/botbrains-io/apis/support-api.md) · [All operations](https://skmtc.net/botbrains-io/apis/support-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/botbrains-io/support-api/versions/d53eac07ba68/schema)