Skip to main content

List Onboardings

GET 
/api/partner/v1/onboarding

Cursor-paginated status feed of every onboarding draft under your partner channels, newest first. Returns { data, next_cursor }; pass the returned next_cursor back as the cursor query param to fetch the next page (next_cursor is null on the last page). per_page defaults to 50 and is capped at 200. Each row is the lightweight { id, ref, channel, status } shape (no next_action or invited). Requires scope onboarding:read.

Request​

Responses​

One page of onboarding drafts.

Last updated on