Skip to content
API Reference
/
Components

Onboarded API (0.0.1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://docs.onboarded.com/_mock/openapi/

https://app.onboarded.com/

Components

Components APIs

Operations

Create a embedded component url

Request

Security
bearerAuth
Bodyapplication/json

Body

componentstringrequired
Enum"employees/list""everify/cases""employee/tasks"
optionsobject
curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/components/create_url \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "component": "employees/list",
    "options": {
      "employee/tasks": {
        "employee_id": "string"
      }
    }
  }'

Responses

200

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

Employees

Employees APIs

Operations

Employers

Employers APIs

Operations

Clients

Clients APIs

Operations

Jobs

Jobs APIs

Operations

Placements

Placements APIs

Operations

Tasks

Tasks APIs

Operations

Task Change Requests

Task Change Requests APIs

Operations

Forms

Forms APIs

Operations

Files

Files APIs

Operations

Themes

Themes APIs

Operations

Custom Properties

Custom Properties APIs

Operations