Get onboarding URL for an employee

Request

Security

form_session or user_session or component_session or component_token or api_token

Path

employee_idstring(EmployeeId)^ee_required

Employee Identifier

Query

assignee_typestring

Type of assignee for onboarding tasks. Defaults to "employee".

Enum:"employee""employer"

placement_idstring(PlacementId)^pla_

Scopes the link to a single placement: the candidate sees only that placement's tasks.

task_idsstring

auto_sequenceboolean

This field should only be set to true when task_ids is provided. Tasks will be automatically sorted to satisfy their form stages' sequence.

localestring

Locale code (e.g. en, es, fr). If not provided, the language will be selected automatically based on candidate browser language setting and form language availability.

redirect_tostring

Redirect to URL to send the user after onboarding is complete

active_theme_idstring

Custom theme for the onboarding form

otp_requiredboolean

Whether OTP verification is required before accessing the onboarding form

otp_methodsstring

Comma-separated list of allowed OTP delivery methods (sms, email)

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/employees/{employee_id}/onboarding?assignee_type=employee&placement_id=pla_abc123def456&task_ids=string&auto_sequence=true&locale=string&redirect_to=string&active_theme_id=string&otp_required=true&otp_methods=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json

urlstringrequired

Response

{
  "url": "string"
}