Playground

Playground

DataSource

/api/v1/datasources

A registered data source, often the origin of synced records.

listgetcreateupdatesync

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
namestringHuman-readable display name for this integration connection.
typestringIntegration type identifying the external system being connected. Drives the connector module and the config schema used for this DataSource.
statusstringCurrent operational status of this integration. 'error' indicates the last sync failed and manual intervention may be required. 'paused' means syncs have been t
last_sync_atdate-timeISO 8601 timestamp of the most recently completed sync run. Null if this DataSource has never successfully synced.
next_sync_atdate-timeISO 8601 timestamp of the next scheduled sync run. Null if no sync is scheduled (e.g. paused or disconnected).
synced_entitiesjsonCount of entities currently synced from this DataSource, broken down by entity type. Updated after each successful sync.
configjsonIntegration-specific configuration for this DataSource. The shape varies by type. Sensitive fields (API keys, client secrets) are stored encrypted and never ret

API

client.datasources.*
Loading manifest…