Sign in

v1

latestOpenAPI 3.1.02026-07-228956435.8 KB
Onboardings

List onboardings

Lists the onboardings of the entity. Only onboardings belonging to the organization of the API key used are visible.

get/entities/{entity_id}/onboardings

Path parameters

entity_idstring required

The unique identifier of the entity (for example ent_8anBwgZktbZH6ydyHa6Tm0eM).

Query parameters

ending_beforestring

Cursor for pagination. Use the id of the first onboarding on the current page to fetch the previous page. Cannot be combined with starting_after.

limitinteger

Maximum number of onboardings to return per page. Defaults to 30, with a maximum of 300.

starting_afterstring

Cursor for pagination. Use the id of the last onboarding on the current page to fetch the next page. Cannot be combined with ending_before.

Response

The list of onboardings of the entity, each as a compact object with its status and timestamps.

idstring required

Unique identifier of the onboarding.

objectstring required

Type of the object. Always onboarding.

entity_idstring required

Identifier of the entity this onboarding belongs to.

status'pending' | 'in_progress' | 'submitted' | 'approved' | 'rejected' | 'cancelled' required

Current status of the onboarding. One of pending, in_progress, submitted, approved, rejected, or cancelled.

source'api' | 'dashboard' required

Channel the onboarding is being completed through. One of api or dashboard.

submitted_atstring date-time nullable required

ISO 8601 datetime, in UTC, of when the onboarding was submitted for review. null until it is submitted.

reviewed_atstring date-time nullable required

ISO 8601 datetime, in UTC, of when the onboarding was reviewed. null until it is reviewed.