x-cpod-domain: org

Org Chart

Departments and locations — the org's structural axes.

Try in explorer client.org · client.platform

Department

A unit in the org structure. Self-referential.

REST path/api/v1/platform/departments

Operations

listgetcreateupdate

SDK

// list — returns only your records; add filters/search:
await client.org.departments.list()

// create:
await client.org.departments.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  app_id: "example app_id",
  created_by: "rec_01HXEXAMPLE",
})

Field	Type	Description
id*	uuid	Server-assigned ULID with type prefix (e.g. per_…).
tenant_id*	string	Tenant scope — auto-stamped from the caller's JWT.
app_id	string	App 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-time	Server stamp.
updated_at*	date-time	Server stamp; updated on every patch.
created_by	uuid	Person id from the caller's JWT (sub).
updated_by	uuid	Person id from the last writer's JWT (sub).
source	string	Provenance tag — defaults to 'edm'.
source_type	enum	Where the write originated. Defaults to 'api'.`frontendbackendserversystemapi`
is_deleted	boolean	Soft-delete flag. Excluded from default list queries.
deleted_at	date-time	Stamped when soft-deleted; null otherwise.
deleted_by	uuid	Person id who soft-deleted; null otherwise.
schema_version	number	Document schema version. Bumped on incompatible writes.
name	string	Full name of the department.
code	string	Short uppercase code uniquely identifying this department within the tenant.
description	string	Optional description of the department's purpose and responsibilities.
head_id	uuid	UUID of the Person who leads this department.
parent_department_id	uuid	UUID of the parent Department for hierarchical org charts. Null for top-level departments.
cost_center_id	uuid	UUID of the CostCenter to which this department's budget is attributed.
location_id	uuid	UUID of the primary Location where this department is based.
headcount	number	Computed count of active Persons assigned to this department. Read-only — derived by the platform.
status	string	Operational status of the department.

Location

A physical office or workplace location.

REST path/api/v1/org/locations

Operations

listgetcreateupdate

SDK

// list — returns only your records; add filters/search:
await client.org.locations.list()

// create:
await client.org.locations.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  app_id: "example app_id",
  created_by: "rec_01HXEXAMPLE",
})

Field	Type	Description
id*	uuid	Server-assigned ULID with type prefix (e.g. per_…).
tenant_id*	string	Tenant scope — auto-stamped from the caller's JWT.
app_id	string	App 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-time	Server stamp.
updated_at*	date-time	Server stamp; updated on every patch.
created_by	uuid	Person id from the caller's JWT (sub).
updated_by	uuid	Person id from the last writer's JWT (sub).
source	string	Provenance tag — defaults to 'edm'.
source_type	enum	Where the write originated. Defaults to 'api'.`frontendbackendserversystemapi`
is_deleted	boolean	Soft-delete flag. Excluded from default list queries.
deleted_at	date-time	Stamped when soft-deleted; null otherwise.
deleted_by	uuid	Person id who soft-deleted; null otherwise.
schema_version	number	Document schema version. Bumped on incompatible writes.
name	string	Human-readable name for the location.
type	string	Classification of the location's primary purpose.
address	json	Postal address of the location.
timezone	string	IANA timezone identifier for the location.
phone	string	Main phone number for this location.
capacity	number	Maximum number of people this location can accommodate.
status	string	Operational status of the location.
tags	json	Free-form tags for grouping or searching locations.

Docs

Department

Location