List deleted entity records
<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>
Returns the records deleted from one of the app's entities that are still in its trash.
A record lands here when Delete entity record removes it, and stays until you bring it back with Restore entity record or erase it with Permanently delete entity record. Row-level security doesn't apply, so you get every deleted record in the entity. The User entity has no trash, because Remove app user deletes a user outright, so asking for its trash returns a 404.
Filter, sort, and page the same way as List entity records, except that the 5000 record cap doesn't apply here: leave out limit to get the whole trash in one response.
<Note>This endpoint accepts a personal API key belonging to a user with editor access to the app. A read-only key is refused, and workspace API keys are not accepted.</Note>
Path parameters
ID of the app that owns the entity.
ID of the app that owns the entity.
Name of the entity, exactly as List entity schemas reports it. Don't pass User here. It doesn't fail, but it reads and writes a separate, disconnected set of records stored under that name, not the app's real user accounts, which are managed through their own endpoints.
Name of the entity, exactly as List entity schemas reports it. Don't pass User here. It doesn't fail, but it reads and writes a separate, disconnected set of records stored under that name, not the app's real user accounts, which are managed through their own endpoints.
Query parameters
Filter as a JSON object of field names and values, for example {"status": "paid"} for an exact match, or using an operator such as $gt for a comparison. See Filtering, sorting, and paging for a full list of operators.
Maximum number of deleted records to return, from 1 to 10000. Leave it out to get every matching deleted record in one response.
Number of deleted records to skip before the ones you get back, 0 or more. Defaults to 0. Use it with limit to page through a long list.
Single field to sort by, prefixed with - for descending. For example, -created_date returns newest first. Sorting by more than one field isn't supported.
Comma-separated list of fields to return, which reduces the response size on a wide entity. Reach a field inside an object with dots, as in customer.email. Each record still carries its id whether you ask for it or not.
Response
The entity's deleted records.
Example response
[
{
"id": "6886b8d390dc7e2f4a2c91b3",
"created_date": "2026-06-01T09:23:41.481000",
"updated_date": "2026-06-04T14:07:02.115000",
"created_by": "jane@acme.com",
"created_by_id": "6874b0c2e1a94d0031bb77de",
"deleted_date": "2026-06-05T11:42:18.207000"
}
]Changes
Changed in 1 of the 14 revisions of this API.1
- ○
endpoint added
endpoint-added
- ○