Developers
ChangelogSupportcoevera.comGet API keys
Set your API contextPick a region and space ID once. Every sample fills in your base URL.
Where do I find these?

In Coevera: open your space's API application and choose Show Access. It shows the space ID and the base URL, whose host starts with your region.

From the API: if you know the space ID, the discovery endpoint GET /api/discovery/spaces/{space_id} returns its region and base URLs, without credentials.

Only the region and space ID are kept, in this browser. Never paste a key or password here.

More in the quickstart

REST APIFields and custom entities

Fields and custom entities

View as Markdown/reference/rest/families/fields.mdOpen in ClaudeAsk Claude about this pageOpen in ChatGPTAsk ChatGPT about this page

Fields and their permissions, entities and their settings, custom entities, forms, lookup data and translations.

  • 17 entities
EntityOperationsSummary
Fields6Fields: list, get, create, update and delete, plus batch restore.
FieldMappings8FieldMappings: list, get, create, update and delete, plus batch operations.
FieldPermissions8FieldPermissions: list, get, create, update and delete, plus batch operations.
FieldSequences Read-only2Read-only: list and get FieldSequences.
Entities Read-only2Read-only: list and get Entities.
EntitySettingses8EntitySettingses: list, get, create, update and delete, plus batch operations.
Custom entity records8Custom entity records: list, get, create, update and delete, plus batch operations.
Custom entity types8Custom entity types: list, get, create, update and delete, plus batch operations.
FormViews8FormViews: list, get, create, update and delete, plus batch operations.
FormViewSharingClientRelations8FormViewSharingClientRelations: list, get, create, update and delete, plus batch operations.
FormViewSharingSalesUnitRelations8FormViewSharingSalesUnitRelations: list, get, create, update and delete, plus batch operations.
Translations8Translations: list, get, create, update and delete, plus batch operations.
Data8Data: list, get, create, update and delete, plus batch operations.
Types Read-only2Read-only: list and get Types.
ImportMappingMasks8ImportMappingMasks: list, get, create, update and delete, plus batch operations.
InterfacePreviews8InterfacePreviews: list, get, create, update and delete, plus batch operations.
Webresources8Webresources: list, get, create, update and delete, plus batch operations.

Indented entities are helpers of the entity above them: sharing, data-exchange and KPI relations.