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
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

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
starting_section_idstring
curl -i -X POST \
  'https://docs.onboarded.com/_mock/openapi/api/v1/tasks/{task_id}/task_change_requests' \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "starting_section_id": "string"
  }'

Responses

TaskChangeRequestSkipped

Bodyapplication/json
_tagstringrequired
Value"skipped"
Response
application/json
{ "_tag": "skipped" }
Operations
Operations