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

Components

API for creating embeddable component URLs

Operations
Operations

Employees

API for managing employees

Operations

Employers

API for managing employers

Operations

Files

API for accessing uploaded files

Operations
Operations
Operations
Operations

Placements

API for managing placements

Operations
Operations

Custom Properties

API for managing custom properties

Operations

Subtasks

Subtask management and file upload API

Operations

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
subtask_idstring(SubtaskId)^subtask_required

Subtask Identifier

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

Responses

Subtask

Bodyapplication/json
idstringrequired

Subtask ID

form_page_idstringrequired

Form page ID associated with this subtask

dataany(any)required

Subtask data

Response
application/json
{ "id": "string", "form_page_id": "string", "data": null }

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
subtask_idstring(SubtaskId)^subtask_required

Subtask Identifier

Bodymultipart/form-datarequired
filesArray of strings(binary)(PersistedFile)required
curl -i -X POST \
  'https://docs.onboarded.com/_mock/openapi/api/v1/subtasks/{subtask_id}/upload' \
  -H 'Content-Type: multipart/form-data' \
  -b __session=YOUR_API_KEY_HERE \
  -F files=string

Responses

UploadFilesResponse

Bodyapplication/json
filesArray of objects(UploadedFile)required
files[].​idstringrequired
files[].​keystringrequired
files[].​namestringrequired
files[].​typestringrequired
files[].​sizenumberrequired
files[].​checksumstringrequired
Response
application/json
{ "files": [ { … } ] }

Task Change Requests

API for requesting changes to completed tasks

Operations
Operations
Operations