Skip to main content
DELETE
Delete entity records

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

app_id
string
required

ID of the app that owns the entity.

entity_name
string
required

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.

Body

application/json

Filter selecting the records to delete, in the same form as q. Send {} to delete every record in the entity.

Response

How many records were deleted.

How many records were deleted.

success
boolean
required

Always true. A delete that doesn't happen returns an error instead.

Example:

true

deleted
integer
required

Number of records moved to the trash. 0 when no record matched the filter.

Example:

3