List Invitations

GET 
/api/partner/v1/onboarding/:ref/invitations

List every invitation on this onboarding (representatives and beneficial owners), ordered by invitation_id ascending. Read-only and free of the invited people's personal data; it keeps working even after the account has been activated.

All invitations are returned in a single invitations array - this endpoint is not paginated (there are only ever a handful of invitations per onboarding), so it accepts no per_page or cursor parameters and returns no next_cursor.

Requires scope onboarding:read.

Request

Responses

200

All invitations for this onboarding, ordered by invitation_id ascending.

401

Missing or invalid partner bearer key.

403

The partner key lacks the onboarding:read scope.

404

No onboarding with this ref exists in one of your channels.