Skip to content
API Reference
/
/
Get onboarding URL for an...

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

Operations

Employees

API for managing employees

Operations

List all employees

Request

Security
user_session or form_session or component_session or component_token or api_token
Query
pagestring(between(1, 1000))

a number between 1 and 1000

per_pagestring(between(1, 100))

a number between 1 and 100

custom_attributesstring
curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/employees?page=string&per_page=string&custom_attributes=string' \
  -b __session=YOUR_API_KEY_HERE

Responses

Success

Bodyapplication/json
dataArray of objects(Employee)required
data[].​idstring(EmployeeId)^ee_required

Employee Identifier

data[].​first_namestringrequired
data[].​middle_namestring
data[].​last_namestringrequired
data[].​emailstring or nullrequired
Any of:
string
data[].​phonestring or nullrequired
Any of:
string
data[].​date_of_birthstring or nullrequired
Any of:
string
data[].​social_security_numberstring or nullrequired
Any of:
string
data[].​has_middle_nameboolean or nullrequired
Any of:
boolean
data[].​addressAddress (object) or nullrequired
Any of:

An address resource

data[].​address.​streetstringrequired
data[].​address.​secondarystring or null
Any of:
string
data[].​address.​citystringrequired
data[].​address.​statestringrequired
data[].​address.​zipstring or null
Any of:
string
data[].​address.​countrystringrequired
data[].​address.​full_addressstring or null
Any of:
string
data[].​custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

data[].​created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

data[].​updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

data[].​property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

totalnumberrequired
current_pagenumberrequired
per_pagenumberrequired
total_pagesnumber
Response
application/json
{
  "data": [
    { … }
  ],
  "total": 0,
  "current_page": 0,
  "per_page": 0,
  "total_pages": 0
}

Create a new employee

Request

Security
user_session or form_session or component_session or component_token or api_token
Bodyapplication/jsonrequired
first_namestringrequired
middle_namestring
last_namestringrequired
emailstring or null
Any of:
string
phonestring or null
Any of:
string
date_of_birthstring or null
Any of:
string
social_security_numberstring or null
Any of:
string
has_middle_nameboolean or null
Any of:
boolean
addressAddress (object) or null
Any of:

An address resource

custom_attributesobject(CustomAttributes)

Record of custom attribute values keyed by string path.

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/employees \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string",
    "date_of_birth": "string",
    "social_security_number": "string",
    "has_middle_name": true,
    "address": {
      "street": "123 Main St",
      "secondary": "Suite 100",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94102",
      "country": "US",
      "full_address": "123 Main St, San Francisco, CA 94102"
    },
    "custom_attributes": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  }'

Responses

An employee with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employee schema.

Bodyapplication/json
idstring(EmployeeId)^ee_required

Employee Identifier

first_namestringrequired
middle_namestring
last_namestringrequired
emailstring or nullrequired
Any of:
string
phonestring or nullrequired
Any of:
string
date_of_birthstring or nullrequired
Any of:
string
social_security_numberstring or nullrequired
Any of:
string
has_middle_nameboolean or nullrequired
Any of:
boolean
addressAddress (object) or nullrequired
Any of:

An address resource

address.​streetstringrequired
address.​secondarystring or null
Any of:
string
address.​citystringrequired
address.​statestringrequired
address.​zipstring or null
Any of:
string
address.​countrystringrequired
address.​full_addressstring or null
Any of:
string
custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response
application/json
{
  "id": "ee_abc123def456",
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "email": "string",
  "phone": "string",
  "date_of_birth": "string",
  "social_security_number": "string",
  "has_middle_name": true,
  "address": {
    "street": "123 Main St",
    "secondary": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94102",
    "country": "US",
    "full_address": "123 Main St, San Francisco, CA 94102"
  },
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "updated_at": "string",
  "property1": null,
  "property2": null
}

Get an employee by ID

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
employee_idstring(EmployeeId)^ee_required

Employee Identifier

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/employees/{employee_id}' \
  -b __session=YOUR_API_KEY_HERE

Responses

An employee with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employee schema.

Bodyapplication/json
idstring(EmployeeId)^ee_required

Employee Identifier

first_namestringrequired
middle_namestring
last_namestringrequired
emailstring or nullrequired
Any of:
string
phonestring or nullrequired
Any of:
string
date_of_birthstring or nullrequired
Any of:
string
social_security_numberstring or nullrequired
Any of:
string
has_middle_nameboolean or nullrequired
Any of:
boolean
addressAddress (object) or nullrequired
Any of:

An address resource

address.​streetstringrequired
address.​secondarystring or null
Any of:
string
address.​citystringrequired
address.​statestringrequired
address.​zipstring or null
Any of:
string
address.​countrystringrequired
address.​full_addressstring or null
Any of:
string
custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response
application/json
{
  "id": "ee_abc123def456",
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "email": "string",
  "phone": "string",
  "date_of_birth": "string",
  "social_security_number": "string",
  "has_middle_name": true,
  "address": {
    "street": "123 Main St",
    "secondary": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94102",
    "country": "US",
    "full_address": "123 Main St, San Francisco, CA 94102"
  },
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "updated_at": "string",
  "property1": null,
  "property2": null
}

Update an employee

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
employee_idstring(EmployeeId)^ee_required

Employee Identifier

Bodyapplication/jsonrequired
first_namestring
middle_namestring
last_namestring
emailstring or null
Any of:
string
phonestring or null
Any of:
string
date_of_birthstring or null
Any of:
string
social_security_numberstring or null
Any of:
string
has_middle_nameboolean or null
Any of:
boolean
addressAddress (object) or null
Any of:

An address resource

custom_attributesobject(CustomAttributes)

Record of custom attribute values keyed by string path.

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/employees/{employee_id}' \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string",
    "date_of_birth": "string",
    "social_security_number": "string",
    "has_middle_name": true,
    "address": {
      "street": "123 Main St",
      "secondary": "Suite 100",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94102",
      "country": "US",
      "full_address": "123 Main St, San Francisco, CA 94102"
    },
    "custom_attributes": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  }'

Responses

An employee with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employee schema.

Bodyapplication/json
idstring(EmployeeId)^ee_required

Employee Identifier

first_namestringrequired
middle_namestring
last_namestringrequired
emailstring or nullrequired
Any of:
string
phonestring or nullrequired
Any of:
string
date_of_birthstring or nullrequired
Any of:
string
social_security_numberstring or nullrequired
Any of:
string
has_middle_nameboolean or nullrequired
Any of:
boolean
addressAddress (object) or nullrequired
Any of:

An address resource

address.​streetstringrequired
address.​secondarystring or null
Any of:
string
address.​citystringrequired
address.​statestringrequired
address.​zipstring or null
Any of:
string
address.​countrystringrequired
address.​full_addressstring or null
Any of:
string
custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response
application/json
{
  "id": "ee_abc123def456",
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "email": "string",
  "phone": "string",
  "date_of_birth": "string",
  "social_security_number": "string",
  "has_middle_name": true,
  "address": {
    "street": "123 Main St",
    "secondary": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94102",
    "country": "US",
    "full_address": "123 Main St, San Francisco, CA 94102"
  },
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "updated_at": "string",
  "property1": null,
  "property2": null
}

Delete an employee

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
employee_idstring(EmployeeId)^ee_required

Employee Identifier

curl -i -X DELETE \
  'https://docs.onboarded.com/_mock/openapi/api/v1/employees/{employee_id}' \
  -b __session=YOUR_API_KEY_HERE

Responses

An employee with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employee schema.

Bodyapplication/json
idstring(EmployeeId)^ee_required

Employee Identifier

first_namestringrequired
middle_namestring
last_namestringrequired
emailstring or nullrequired
Any of:
string
phonestring or nullrequired
Any of:
string
date_of_birthstring or nullrequired
Any of:
string
social_security_numberstring or nullrequired
Any of:
string
has_middle_nameboolean or nullrequired
Any of:
boolean
addressAddress (object) or nullrequired
Any of:

An address resource

address.​streetstringrequired
address.​secondarystring or null
Any of:
string
address.​citystringrequired
address.​statestringrequired
address.​zipstring or null
Any of:
string
address.​countrystringrequired
address.​full_addressstring or null
Any of:
string
custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response
application/json
{
  "id": "ee_abc123def456",
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "email": "string",
  "phone": "string",
  "date_of_birth": "string",
  "social_security_number": "string",
  "has_middle_name": true,
  "address": {
    "street": "123 Main St",
    "secondary": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94102",
    "country": "US",
    "full_address": "123 Main St, San Francisco, CA 94102"
  },
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "updated_at": "string",
  "property1": null,
  "property2": null
}

Get onboarding URL for an employee

Request

Security
user_session or form_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"
task_idsstring

Comma-separated list of task IDs

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

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/employees/{employee_id}/onboarding?assignee_type=employee&task_ids=string&locale=string&redirect_to=string&active_theme_id=string' \
  -b __session=YOUR_API_KEY_HERE

Responses

Success

Bodyapplication/json
urlstringrequired
Response
application/json
{
  "url": "string"
}

Migrate completed task progress

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
employee_idstring(EmployeeId)^ee_required

Employee Identifier

Bodyapplication/jsonrequired
target_employee_idstring(EmployeeId)^ee_required

Employee Identifier

curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/employees/{employee_id}/migrate_completed_tasks_progress' \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "target_employee_id": "ee_abc123def456"
  }'

Responses

Success

Response
No content

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

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