engagements
Opportunities module · 4 operations
List engagement rows
GET/engagements
An external relationship: a person or external account working for an org. It cannot become Active until every blocking onboarding item passes. Returns a cursor page of engagement rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
Create an engagement
POST/engagements
An external relationship: a person or external account working for an org. It cannot become Active until every blocking onboarding item passes. Creates an engagement. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
Get an engagement
GET/engagements/{id}
An external relationship: a person or external account working for an org. It cannot become Active until every blocking onboarding item passes. Returns one engagement with its `ETag`. A engagement the caller may not see returns 404.
Transition the engagement state
POST/engagements/{id}/transitions
Moves the engagement state machine through its transition RPC, which writes its ledger. Active is refused until every blocking onboarding item passes. Complete narrows external access to money and documents. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.