Skip to content
/Components

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

Create a component URL

Request

Security
user_session or form_session or component_session or component_token or api_token
Bodyapplication/jsonrequired
Any of:
Any of:
componentstringrequired
Value"employees/list"
filtersobject
optionsobject
curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/components/create_url \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "component": "employee/tasks",
    "employee_id": "ee_abc123def456",
    "filters": {
      "task_id": "string",
      "employee_id": "string",
      "employer_id": "string",
      "client_id": "string",
      "job_id": "string",
      "form_id": "string",
      "employee_cv_uid": "string",
      "progress": "string",
      "next_action": "string",
      "custom_view_id": "string",
      "assignee": "string",
      "order_by": "string",
      "order_dir": "string",
      "page": "string",
      "per_page": "string"
    },
    "options": {
      "redirect_url_expires_in": 0,
      "session_expires_in": 0
    }
  }'

Responses

Success

Bodyapplication/json
componentstringrequired
Enum"employees/list""everify/cases""employee/tasks"
redirect_urlstringrequired
codestringrequired
Response
application/json
{
  "component": "employees/list",
  "redirect_url": "string",
  "code": "string"
}

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

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