Playground

Playground

Project

/api/v1/edm-projects/projects

A delivery effort with a start, end, and team.

listgetcreateupdatedelete

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.
owner_idstringUser ID of the project manager. Format: usr-<uuid>.
namestringHuman-readable project name.
keystringShort project code used as a prefix for task numbers.
kindstringProject classification.
account_idstringAccount ID if this is a client-facing project.
deal_idstringSource deal ID, if this project was created from a deal.
statusstringCurrent project lifecycle status.
prioritystringProject priority level.
start_datedate-timePlanned project start date.
end_datedate-timePlanned project end date.
actual_start_datedate-timeActual project start date.
actual_end_datedate-timeActual project completion date.
budgetjsonBudget tracking for the project.
member_idsjsonUser IDs of project members. Format: usr-<uuid>.
membersjsonProject members with their roles.
group_idsjsonGroup IDs of owning teams. Format: grp-<uuid>.
repository_refsjsonLinked source code repositories.
descriptionstringFree-text project description.
objectivesjsonFree-text project goals.
linked_objective_idsjsonCross-links to OKR Objective records. Format: obj-<uuid>.
attachment_refsjsonReferences to attached documents or files.
custom_fieldsjsonArbitrary key-value extension fields.
tagsjsonFlat string tags for filtering and grouping.
versionnumberOptimistic-concurrency version counter.
due_datedate-timeProject due date.

API

client.projects.projects.*
Loading manifest…