Count entity records

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Returns how many records an entity holds. Deleted records are not counted.

The count covers the records the calling credential can read, so an entity whose row-level security rules narrow reads returns a smaller number than the entity actually holds. An entity with no rls rules returns its full count.

Pass the entity name exactly as List entity schemas reports it. To count the app's users, use Count app users instead: User is served by its own endpoint and never reaches this one.

This endpoint is limited to 100 requests per minute per app, shared with the app's other entity listing calls.

<Note>This endpoint accepts a personal API key belonging to a user with editor access to the app. Workspace API keys are not accepted.</Note>

get/api/apps/{app_id}/entities/{entity_name}/count

Path parameters

entity_namestring required
app_idstring required

ID of the app.

ID of the app.

Response

The number of readable records.

countinteger required

Number of records you can read in this entity.

Example response

{
  "count": 128
}

Changes

Changed in 1 of the 10 revisions of this API.1