Playground

Playground

Application

/api/v1/integration/applications

A registered app integrating with cPod.

listgetcreateupdate

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.
display_namestringHuman-readable name, e.g. CRM 360.
slugstringStable lowercase app slug; the value stamped into app_id.
kindstringapp = user-facing; platform-service = cpod-backend/cpod-arai/coreiq/core-sdk; library = no runtime identity.
primary_domainstringModel domain primarily served.
descriptionstringWhat the app does.
oauth_client_idstringRegistered OAuth client id. core-sdk maps a validated token's client_id to this id to stamp appId on every write.
statusstringLifecycle status of the application.
canonical_owner_ofjsonEntity types this app is the canonical owner of; empty for pure consumers.
api_base_pathstringBase path the app serves or is reached at, e.g. /v1/deals.
repositorystringSource repository.
versionnumberOptimistic concurrency version counter.

API

Loading manifest…