API Reference
//
Get onboarding URL for a...
Security
form_session or user_session or component_session or component_token or api_token
Where the link opens. onboarding_flow (the default) opens the onboarding form; candidate_portal opens the candidate portal, which lists all of the employee's tasks. candidate_portal is only allowed when assignee_type is employee, when redirect_to is not set, and for an organization that has the candidate portal enabled.
Enum:"onboarding_flow""candidate_portal"
When true, whoever opens this link must sign in to Onboarded before accessing the onboarding form. Only allowed when assignee_type is employer. The person must have an Onboarded user with edit permission on the link's tasks. Sign-in can add friction when the link is rendered in an iframe, especially in Safari.
- Mock serverhttps://docs.onboarded.com/_mock/openapi/api/v1/tasks/{task_id}/onboarding
- Onboarded Production Serverhttps://app.onboarded.com/api/v1/tasks/{task_id}/onboarding
curl -i -X GET \
'https://docs.onboarded.com/_mock/openapi/api/v1/tasks/{task_id}/onboarding?expired_at=string&assignee_type=employee&locale=string&redirect_to=string&landing_page=onboarding_flow&otp_required=true&otp_methods=string&user_auth_session_required=true' \
-H 'Authorization: Bearer <YOUR_Onboarded form session token_HERE>'