Back to API Docs
Custom Entities
Work with custom entity schemas and records. Entities allow you to model your business data with custom fields and relationships.
Endpoints (10)
GET
List entity records
/entities/{entity_key}/recordsReturns a paginated list of records for an entity.
POST
Create entity record
/entities/{entity_key}/recordsCreates a new record for an entity.
GET
Get entity record
/entities/{entity_key}/records/{record_id}Returns a specific entity record by ID.
PATCH
Update entity record
/entities/{entity_key}/records/{record_id}Updates an existing entity record.
DELETE
Delete entity record
/entities/{entity_key}/records/{record_id}Deletes an entity record.
GET
List entity versions
/entities/{entity_key}/versionsReturns all versions of an entity schema.
GET
Get entity version
/entities/{entity_key}/versions/{version_id}Returns details of a specific entity version including fields and layouts.
GET
Get active entity version
/entities/{entity_key}/versions/activeReturns the currently active version for an entity with its full schema.
GET
List entity schemas
/entities/schemaReturns a list of all entity schemas available in your organization.
GET
Get entity schema
/entities/schema/{entity_key}Returns details of a specific entity schema by entity_key.