# Get an employee onboarding url

Endpoint: GET /api/v1/employees/{id}/onboarding
Version: 0.0.1
Security: bearerAuth

## Path parameters:

  - `id` (string, required)

## Query parameters:

  - `assignee_type` (string)
    Enum: "employee", "employer"

  - `task_ids` (string)
    Comma separated list of task ids

  - `locale` (string)
    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.
    Enum: "af", "ak", "sq", "am", "ar", "hy", "as", "ay", "az", "bm", "bn", "eu", "be", "bho", "bs", "bg", "my", "ca", "ceb", "ckb", "zh-CN", "zh-TW", "co", "hr", "cs", "da", "dv", "doi", "nl", "en", "eo", "et", "ee", "fil", "fi", "fr", "gl", "lg", "ka", "de", "el", "gu", "ht", "ha", "haw", "he", "hi", "hmn", "hu", "is", "ig", "ilo", "id", "ga", "it", "ja", "jv", "kn", "kk", "km", "rw", "kok", "ko", "kri", "ku", "ky", "lo", "la", "lv", "ln", "lt", "lb", "mk", "mai", "mg", "ms", "ml", "mt", "mni-Mtei", "mi", "mr", "lus", "mn", "ne", "nso", "no", "ny", "or", "om", "ps", "fa", "pl", "pt", "pa", "qu", "ro", "ru", "sm", "sa", "gd", "sr", "sn", "sd", "si", "sk", "sl", "so", "st", "es", "su", "sw", "sv", "tg", "ta", "tt", "te", "th", "ti", "ts", "tr", "tk", "uk", "ur", "ug", "uz", "vi", "cy", "fy", "xh", "yi", "yo", "zu"

  - `redirect_to` (string)
    Redirect to url to send the user after onboarding is complete

  - `active_theme_id` (string)
    Custom theme for the onboarding form

## Response 200 fields (application/json):

  - `url` (string, required)

## Response 400 fields (application/json):

  - `message` (string, required)

## Response 401 fields (application/json):

  - `message` (string, required)
    Enum: "Not authorized"

## Response 404 fields (application/json):

  - `message` (string, required)
    Enum: "Employee not found"