Entities API
Create, read, update, and delete entities via the REST API.
2 min read
Entities API
CRUD operations for entities (data rows) within entity types.
List Entities
GET /api/entities?entityTypeId={id}&limit=50&offset=0
Query Parameters
entityTypeIdstringrequired
The entity type to query.
limitnumber
Maximum number of results to return (max: 200).
offsetnumber
Pagination offset for skipping results.
Response
dataEntity[]
Array of entity objects matching the query.
meta.totalnumber
Total count of entities matching the query (before pagination).
Get Entity
GET /api/entities/{entityId}
Create Entity
POST /api/entities
Request Body
entityTypeIdstringrequired
The entity type to create the entity in.
fieldsobjectrequired
Key-value pairs matching the entity type's field schema.
Update Entity
PATCH /api/entities/{entityId}
Request Body
fieldsobjectrequired
Partial key-value pairs to update. Only specified fields are changed.
Delete Entity
DELETE /api/entities/{entityId}
Note
Delete performs a soft delete (sets `archivedAt`). The entity can be restored within 30 days.
Was this helpful?