Skip to content
XOS Developers

onboardingItems

Opportunities module · 4 operations

List onboarding item rows

GET/onboarding-items

One onboarding requirement instantiated for an engagement. Returns a cursor page of onboarding item rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create an onboarding item

POST/onboarding-items

One onboarding requirement instantiated for an engagement. Creates an onboarding item. 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 onboarding item

GET/onboarding-items/{id}

One onboarding requirement instantiated for an engagement. Returns one onboarding item with its `ETag`. A onboarding item the caller may not see returns 404.

Submit an onboarding item

POST/onboarding-items/{id}/submit

The engaged party submits the item while onboarding is open, optionally attaching a document of the org. Anyone else is refused (403). Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.