Group
/api/v1/groupsA set of Persons or Groups. Self-referential.
listgetcreateupdatedeleteSchema
| Field | Type | Notes |
|---|---|---|
| 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 | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| 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 | Canonical name of the group. For AD-sourced groups, this is the sAMAccountName or distinguished name. Should be unique within a given source. |
| type | string | Classification of the group's purpose. 'ad_group' groups are typically synced from Active Directory or Azure AD. 'custom' groups are manually created in cPod. |
| description | string | Human-readable description of the group's purpose. |
| owner_id | uuid | UUID of the Person responsible for this group. The owner is the authoritative approver for membership changes. |
| members | json | Current membership list for this group. Each entry links a Person to this group with an optional role. |
| parent_group_id | uuid | UUID of the parent Group, enabling group hierarchies (e.g. a team nested inside a department group). Null for top-level groups. |
| display_name | string | Human-friendly name shown in cPod (SCIM owns the canonical name). |
| kind | enum | department | team | cohort | squad | committee | ad_group | distribution_list | customClassification of the group's purpose. |
| source | enum | manual | active_directory | azure_ad | okta | scimSystem of record the group was sourced from. |
| tags | json | Free-form labels applied to the group (e.g. 'engineering', 'on-call'). |
API
client.groups.*Loading manifest…