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.

Returns a maximum of 100 records per page.

Allowed For

Agents

Servers

https://{subdomain}.{domain}.com

Query parameters

Name Type Required Description

Name	Type	Required	Description
`page`		No	Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: `?page=2` (integer page number) Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both.
`per_page`	Integer	No	Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.
`sort`	String	No	Field to sort results by. Prefix with `-` for descending order. When used with cursor pagination, this determines the cursor ordering. Example: `?sort=name` or `?sort=-created_at`

page

No

Pagination parameter. Supports both traditional offset and cursor-based pagination:

Traditional: ?page=2 (integer page number)
Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before)

These are mutually exclusive - use one format or the other, not both.

per_page

Integer

No

Number of records to return per page.

Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.

sort

String

No

Field to sort results by. Prefix with - for descending order.

When used with cursor pagination, this determines the cursor ordering.

Example: ?sort=name or ?sort=-created_at

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.

All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.

Pricing Templates Integrations Blog Contact Us Help

Terms of Service Privacy Policy