Skip to content

Onboarded Public API (0.0.1)

Public API for Customers, Partners, and Integrations

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

API for creating embeddable component URLs

Operations

API for managing connected organizations and their configuration

Operations

API for managing employees

Operations

API for managing employers

Operations

API for accessing uploaded files

Operations
Operations
Operations

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

form_idstring(FormId)

Form Identifier (lineage uid)

employee_idstring(EmployeeId)^ee_

Employee Identifier

employer_idstring(EmployerId)^er_

Employer Identifier

client_idstring(ClientId)^cl_

Client Identifier

job_idstring(JobId)^job_

Job Identifier

statusstring
Enum"requires_action""completed""expired"
expired_at_ltestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

expired_at_gtestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

due_at_ltestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

due_at_gtestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

completed_at_ltestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

completed_at_gtestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

created_at_ltestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

created_at_gtestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/tasks?page=string&per_page=string&form_id=tlin_abc123def456&employee_id=ee_abc123def456&employer_id=er_abc123def456&client_id=cl_abc123def456&job_id=job_abc123def456&status=requires_action&expired_at_lte=string&expired_at_gte=string&due_at_lte=string&due_at_gte=string&completed_at_lte=string&completed_at_gte=string&created_at_lte=string&created_at_gte=string' \
  -b __session=YOUR_API_KEY_HERE

Responses

Success

Bodyapplication/json
dataArray of objects(Task)required
data[].​idstring(TaskId)^task_required

Task Identifier

data[].​form_idstring(FormId)required

Form Identifier (lineage uid)

data[].​form_custom_attributesobjectrequired
data[].​namestringrequired

The name of the form

data[].​employee_idstring(EmployeeId)^ee_required

Employee Identifier

data[].​employer_idEmployerId (string) or nullrequired
Any of:

Employer Identifier

string(EmployerId)^er_
data[].​client_idClientId (string) or nullrequired
Any of:

Client Identifier

string(ClientId)^cl_
data[].​job_idJobId (string) or nullrequired
Any of:

Job Identifier

string(JobId)^job_
data[].​statusstringrequired
Enum"requires_action""completed""expired"
data[].​next_actionobjectrequired
data[].​next_action.​typestring or nullrequired
Any of:
string
Enum"employer_action""employee_action""system_action"
data[].​expired_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
data[].​deletion_scheduled_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
data[].​deletion_allowed_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
data[].​due_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
data[].​completed_atDateTimeUtc (string) or nullrequired

This field is set when the task status changes to completed.

Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
data[].​progressobjectrequired
data[].​progress.​percentnumberrequired
data[].​progress.​numeratornumberrequired
data[].​progress.​denominatornumberrequired
data[].​subtasksArray of objectsrequired
data[].​subtasks[].​idstringrequired
data[].​subtasks[].​form_page_idstringrequired
data[].​subtasks[].​assignee_typestringrequired
Enum"employee""employer"
data[].​subtasks[].​form_sectionobject or nullrequired
Any of:
data[].​subtasks[].​form_section.​idstringrequired
data[].​subtasks[].​form_section.​positionnumberrequired
data[].​subtasks[].​form_section.​assignee_typestringrequired
Enum"employee""employer""system"
data[].​subtasks[].​progressobjectrequired
data[].​subtasks[].​progress.​percentnumberrequired
data[].​subtasks[].​progress.​numeratornumberrequired
data[].​subtasks[].​progress.​denominatornumberrequired
data[].​tagsArray of objectsrequired
data[].​tags[].​namestringrequired
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[].​_tagstringrequired
Value"Task"
totalnumberrequired
current_pagenumberrequired
per_pagenumberrequired
total_pagesnumber
Response
application/json
{ "data": [ { … } ], "total": 0, "current_page": 0, "per_page": 0, "total_pages": 0 }

Request

Security
user_session or form_session or component_session or component_token or api_token
Query
allow_duplicatestring
Enum"true""false""True""False"
Bodyapplication/jsonrequired
form_idstring(FormId)required

Form Identifier (lineage uid)

employee_idstring(EmployeeId)^ee_required

Employee Identifier

employer_id(EmployerId (string) or null) or null
Any of:
Any of:

Employer Identifier

string(EmployerId)^er_
client_id(ClientId (string) or null) or null
Any of:
Any of:

Client Identifier

string(ClientId)^cl_
job_id(JobId (string) or null) or null
Any of:
Any of:

Job Identifier

string(JobId)^job_
placement_id(PlacementId (string) or null) or null
Any of:
Any of:

Placement Identifier

string(PlacementId)^pla_
expired_atDateTimeUtc (string) or null
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
due_atDateTimeUtc (string) or null
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
deletion_scheduled_atDateTimeUtc (string) or null
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
deletion_allowed_atDateTimeUtc (string) or null
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
curl -i -X POST \
  'https://docs.onboarded.com/_mock/openapi/api/v1/tasks?allow_duplicate=true' \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "form_id": "tlin_abc123def456",
    "employee_id": "ee_abc123def456",
    "employer_id": "er_abc123def456",
    "client_id": "cl_abc123def456",
    "job_id": "job_abc123def456",
    "placement_id": "pla_abc123def456",
    "expired_at": "string",
    "due_at": "string",
    "deletion_scheduled_at": "string",
    "deletion_allowed_at": "string"
  }'

Responses

Task

Bodyapplication/json
idstring(TaskId)^task_required

Task Identifier

form_idstring(FormId)required

Form Identifier (lineage uid)

form_custom_attributesobjectrequired
namestringrequired

The name of the form

employee_idstring(EmployeeId)^ee_required

Employee Identifier

employer_idEmployerId (string) or nullrequired
Any of:

Employer Identifier

string(EmployerId)^er_
client_idClientId (string) or nullrequired
Any of:

Client Identifier

string(ClientId)^cl_
job_idJobId (string) or nullrequired
Any of:

Job Identifier

string(JobId)^job_
statusstringrequired
Enum"requires_action""completed""expired"
next_actionobjectrequired
next_action.​typestring or nullrequired
Any of:
string
Enum"employer_action""employee_action""system_action"
expired_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
deletion_scheduled_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
deletion_allowed_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
due_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
completed_atDateTimeUtc (string) or nullrequired

This field is set when the task status changes to completed.

Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
progressobjectrequired
progress.​percentnumberrequired
progress.​numeratornumberrequired
progress.​denominatornumberrequired
subtasksArray of objectsrequired
subtasks[].​idstringrequired
subtasks[].​form_page_idstringrequired
subtasks[].​assignee_typestringrequired
Enum"employee""employer"
subtasks[].​form_sectionobject or nullrequired
Any of:
subtasks[].​form_section.​idstringrequired
subtasks[].​form_section.​positionnumberrequired
subtasks[].​form_section.​assignee_typestringrequired
Enum"employee""employer""system"
subtasks[].​progressobjectrequired
subtasks[].​progress.​percentnumberrequired
subtasks[].​progress.​numeratornumberrequired
subtasks[].​progress.​denominatornumberrequired
tagsArray of objectsrequired
tags[].​namestringrequired
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

_tagstringrequired
Value"Task"
Response
application/json
{ "id": "task_abc123def456", "form_id": "tlin_abc123def456", "form_custom_attributes": { "property1": null, "property2": null }, "name": "string", "employee_id": "ee_abc123def456", "employer_id": "er_abc123def456", "client_id": "cl_abc123def456", "job_id": "job_abc123def456", "status": "requires_action", "next_action": { "type": "employer_action" }, "expired_at": "string", "deletion_scheduled_at": "string", "deletion_allowed_at": "string", "due_at": "string", "completed_at": "string", "progress": { "percent": 0, "numerator": 0, "denominator": 0 }, "subtasks": [ { … } ], "tags": [ { … } ], "created_at": "string", "updated_at": "string", "_tag": "Task" }

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
task_idstring(TaskId)^task_required

Task Identifier

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

Responses

Task

Bodyapplication/json
idstring(TaskId)^task_required

Task Identifier

form_idstring(FormId)required

Form Identifier (lineage uid)

form_custom_attributesobjectrequired
namestringrequired

The name of the form

employee_idstring(EmployeeId)^ee_required

Employee Identifier

employer_idEmployerId (string) or nullrequired
Any of:

Employer Identifier

string(EmployerId)^er_
client_idClientId (string) or nullrequired
Any of:

Client Identifier

string(ClientId)^cl_
job_idJobId (string) or nullrequired
Any of:

Job Identifier

string(JobId)^job_
statusstringrequired
Enum"requires_action""completed""expired"
next_actionobjectrequired
next_action.​typestring or nullrequired
Any of:
string
Enum"employer_action""employee_action""system_action"
expired_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
deletion_scheduled_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
deletion_allowed_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
due_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
completed_atDateTimeUtc (string) or nullrequired

This field is set when the task status changes to completed.

Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
progressobjectrequired
progress.​percentnumberrequired
progress.​numeratornumberrequired
progress.​denominatornumberrequired
subtasksArray of objectsrequired
subtasks[].​idstringrequired
subtasks[].​form_page_idstringrequired
subtasks[].​assignee_typestringrequired
Enum"employee""employer"
subtasks[].​form_sectionobject or nullrequired
Any of:
subtasks[].​form_section.​idstringrequired
subtasks[].​form_section.​positionnumberrequired
subtasks[].​form_section.​assignee_typestringrequired
Enum"employee""employer""system"
subtasks[].​progressobjectrequired
subtasks[].​progress.​percentnumberrequired
subtasks[].​progress.​numeratornumberrequired
subtasks[].​progress.​denominatornumberrequired
tagsArray of objectsrequired
tags[].​namestringrequired
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

_tagstringrequired
Value"Task"
Response
application/json
{ "id": "task_abc123def456", "form_id": "tlin_abc123def456", "form_custom_attributes": { "property1": null, "property2": null }, "name": "string", "employee_id": "ee_abc123def456", "employer_id": "er_abc123def456", "client_id": "cl_abc123def456", "job_id": "job_abc123def456", "status": "requires_action", "next_action": { "type": "employer_action" }, "expired_at": "string", "deletion_scheduled_at": "string", "deletion_allowed_at": "string", "due_at": "string", "completed_at": "string", "progress": { "percent": 0, "numerator": 0, "denominator": 0 }, "subtasks": [ { … } ], "tags": [ { … } ], "created_at": "string", "updated_at": "string", "_tag": "Task" }

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
task_idstring(TaskId)^task_required

Task Identifier

Bodyapplication/jsonrequired
expired_atDateTimeUtc (string) or null
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
deletion_scheduled_atDateTimeUtc (string) or null
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
deletion_allowed_atDateTimeUtc (string) or null
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/tasks/{task_id}' \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "expired_at": "string",
    "deletion_scheduled_at": "string",
    "deletion_allowed_at": "string"
  }'

Responses

Task

Bodyapplication/json
idstring(TaskId)^task_required

Task Identifier

form_idstring(FormId)required

Form Identifier (lineage uid)

form_custom_attributesobjectrequired
namestringrequired

The name of the form

employee_idstring(EmployeeId)^ee_required

Employee Identifier

employer_idEmployerId (string) or nullrequired
Any of:

Employer Identifier

string(EmployerId)^er_
client_idClientId (string) or nullrequired
Any of:

Client Identifier

string(ClientId)^cl_
job_idJobId (string) or nullrequired
Any of:

Job Identifier

string(JobId)^job_
statusstringrequired
Enum"requires_action""completed""expired"
next_actionobjectrequired
next_action.​typestring or nullrequired
Any of:
string
Enum"employer_action""employee_action""system_action"
expired_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
deletion_scheduled_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
deletion_allowed_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
due_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
completed_atDateTimeUtc (string) or nullrequired

This field is set when the task status changes to completed.

Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
progressobjectrequired
progress.​percentnumberrequired
progress.​numeratornumberrequired
progress.​denominatornumberrequired
subtasksArray of objectsrequired
subtasks[].​idstringrequired
subtasks[].​form_page_idstringrequired
subtasks[].​assignee_typestringrequired
Enum"employee""employer"
subtasks[].​form_sectionobject or nullrequired
Any of:
subtasks[].​form_section.​idstringrequired
subtasks[].​form_section.​positionnumberrequired
subtasks[].​form_section.​assignee_typestringrequired
Enum"employee""employer""system"
subtasks[].​progressobjectrequired
subtasks[].​progress.​percentnumberrequired
subtasks[].​progress.​numeratornumberrequired
subtasks[].​progress.​denominatornumberrequired
tagsArray of objectsrequired
tags[].​namestringrequired
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

_tagstringrequired
Value"Task"
Response
application/json
{ "id": "task_abc123def456", "form_id": "tlin_abc123def456", "form_custom_attributes": { "property1": null, "property2": null }, "name": "string", "employee_id": "ee_abc123def456", "employer_id": "er_abc123def456", "client_id": "cl_abc123def456", "job_id": "job_abc123def456", "status": "requires_action", "next_action": { "type": "employer_action" }, "expired_at": "string", "deletion_scheduled_at": "string", "deletion_allowed_at": "string", "due_at": "string", "completed_at": "string", "progress": { "percent": 0, "numerator": 0, "denominator": 0 }, "subtasks": [ { … } ], "tags": [ { … } ], "created_at": "string", "updated_at": "string", "_tag": "Task" }

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
task_idstring(TaskId)^task_required

Task Identifier

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

Responses

Task

Bodyapplication/json
idstring(TaskId)^task_required

Task Identifier

form_idstring(FormId)required

Form Identifier (lineage uid)

form_custom_attributesobjectrequired
namestringrequired

The name of the form

employee_idstring(EmployeeId)^ee_required

Employee Identifier

employer_idEmployerId (string) or nullrequired
Any of:

Employer Identifier

string(EmployerId)^er_
client_idClientId (string) or nullrequired
Any of:

Client Identifier

string(ClientId)^cl_
job_idJobId (string) or nullrequired
Any of:

Job Identifier

string(JobId)^job_
statusstringrequired
Enum"requires_action""completed""expired"
next_actionobjectrequired
next_action.​typestring or nullrequired
Any of:
string
Enum"employer_action""employee_action""system_action"
expired_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
deletion_scheduled_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
deletion_allowed_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
due_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
completed_atDateTimeUtc (string) or nullrequired

This field is set when the task status changes to completed.

Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
progressobjectrequired
progress.​percentnumberrequired
progress.​numeratornumberrequired
progress.​denominatornumberrequired
subtasksArray of objectsrequired
subtasks[].​idstringrequired
subtasks[].​form_page_idstringrequired
subtasks[].​assignee_typestringrequired
Enum"employee""employer"
subtasks[].​form_sectionobject or nullrequired
Any of:
subtasks[].​form_section.​idstringrequired
subtasks[].​form_section.​positionnumberrequired
subtasks[].​form_section.​assignee_typestringrequired
Enum"employee""employer""system"
subtasks[].​progressobjectrequired
subtasks[].​progress.​percentnumberrequired
subtasks[].​progress.​numeratornumberrequired
subtasks[].​progress.​denominatornumberrequired
tagsArray of objectsrequired
tags[].​namestringrequired
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

_tagstringrequired
Value"Task"
Response
application/json
{ "id": "task_abc123def456", "form_id": "tlin_abc123def456", "form_custom_attributes": { "property1": null, "property2": null }, "name": "string", "employee_id": "ee_abc123def456", "employer_id": "er_abc123def456", "client_id": "cl_abc123def456", "job_id": "job_abc123def456", "status": "requires_action", "next_action": { "type": "employer_action" }, "expired_at": "string", "deletion_scheduled_at": "string", "deletion_allowed_at": "string", "due_at": "string", "completed_at": "string", "progress": { "percent": 0, "numerator": 0, "denominator": 0 }, "subtasks": [ { … } ], "tags": [ { … } ], "created_at": "string", "updated_at": "string", "_tag": "Task" }

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
task_idstring(TaskId)^task_required

Task Identifier

Query
include_sensitive_infostring
Enum"true""false""True""False"
curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/tasks/{task_id}/fields?include_sensitive_info=true' \
  -b __session=YOUR_API_KEY_HERE

Responses

Success

Bodyapplication/json
fieldsArray of objectsrequired
fields[].​typestringrequired
fields[].​pathstringrequired
fields[].​labelobjectrequired
fields[].​label.​enstring or nullrequired

Label for the field, in english (if available)

Any of:

Label for the field, in english (if available)

string
fields[].​valueany(any)required

The value of the field

Response
application/json
{ "fields": [ { … } ] }

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
task_idstring(TaskId)^task_required

Task Identifier

Bodyapplication/jsonrequired
fieldsArray of objectsrequired
fields[].​pathstringrequired
fields[].​valueany(any)required

The value of the field

curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/tasks/{task_id}/fields' \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "fields": [
      {
        "path": "string",
        "value": null
      }
    ]
  }'

Responses

Success

Bodyapplication/json
null
Response
application/json
null

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
task_idstring(TaskId)^task_required

Task Identifier

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

Responses

a string

Bodytext/plain
string
Response
No content

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
task_idstring(TaskId)^task_required

Task Identifier

Query
assignee_typestringrequired
Enum"employee""employer"
localestring
redirect_tostring
curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/tasks/{task_id}/onboarding?assignee_type=employee&locale=string&redirect_to=string' \
  -b __session=YOUR_API_KEY_HERE

Responses

Success

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

API for managing placements

Operations
Operations

API for managing custom properties

Operations

Subtask management and file upload API

Operations

API for requesting changes to completed tasks

Operations
Operations
Operations