Skip to content
/Magic Links

Onboarded Public API (0.0.1)

Public API for Customers, Partners, and Integrations

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.onboarded.com/_mock/openapi
Onboarded Production Server
https://app.onboarded.com

Clients

API for managing clients

Operations

Components

API for creating embeddable component URLs

Operations

Connected Organizations

API for managing connected organizations and their configuration

Operations

Employees

API for managing employees

Operations

Employers

API for managing employers

Operations

Files

API for accessing uploaded files

Operations

Forms

API for accessing forms

Operations

Tasks

API for managing tasks

Operations

Jobs

API for managing jobs

Operations

Placements

API for managing placements

Operations

Themes

API for managing themes

Operations

Custom Properties

API for managing custom properties

Operations

Create a magic link

Request

Security
user_session or form_session or component_session or component_token or api_token
Bodyapplication/jsonrequired
user_emailstring(email)
user_external_idstring

Custom identifier provided upon user creation. Can be provided with or without user_email. If user_email is omitted, however, this field must uniquely identify a user. An error will be returned if multiple users hold the same external_id.

expire_ininteger(between(1, 86400))[ 1 .. 86400 ]required

a number between 1 and 86400

redirect_pathMagicLinkRedirectPath (string) or null
Any of:

Optional redirect path within the dashboard (must be a relative path starting with '/' and cannot contain external URLs). Examples: /dashboard, /employees/ee_123

string(MagicLinkRedirectPath)
curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/magic_links \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "user_email": "user@example.com",
    "user_external_id": "string",
    "expire_in": 1,
    "redirect_path": "string"
  }'

Responses

Success

Bodyapplication/json
urlstring^https?:\/\/.+required

a string matching the pattern ^https?://.+

expire_atstringrequired
redirect_path_deprecation_deadlinestring(date-time)required

The date and time when the redirect_path parameter will become invalid and stop working

redirect_path_deprecation_notestringrequired

Information about what to use instead of the deprecated redirect_path parameter

Response
application/json
{
  "url": "string",
  "expire_at": "string",
  "redirect_path_deprecation_deadline": "2019-08-24T14:15:22Z",
  "redirect_path_deprecation_note": "string"
}

Subtasks

Subtask management and file upload API

Operations

Task Change Requests

API for requesting changes to completed tasks

Operations

Users

API for managing users

Operations

Webhooks

API for managing webhooks

Operations