v29

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-13511526891.2 KB
Users

List 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
get/api/v2/deleted_users

Query parameters

page[before]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[after]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[size]integer

Specifies how many records should be returned in the response. You can specify up to 100 records per page.

Response

Success response