Skip to content
API Reference
/
/
List all placements

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

Employees

Employees APIs

Operations

Employers

Employers APIs

Operations

Clients

Clients APIs

Operations

Jobs

Jobs APIs

Operations

Placements

Placements APIs

Operations

Get a preview of a placement and its tasks

Request

Security
bearerAuth
Bodyapplication/json

Body

employee_idstringrequired
employer_idstring
client_idstring
job_idstring
custom_attributesobject or null

Custom attributes

curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/placements/preview \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "employee_id": "string",
    "employer_id": "string",
    "client_id": "string",
    "job_id": "string",
    "custom_attributes": {}
  }'

Responses

200

Bodyapplication/json
idstringrequired
employee_idstringrequired
employer_idstring or nullrequired
client_idstring or nullrequired
job_idstring or nullrequired
custom_attributesobjectrequired

Custom attribute values

missing_task_countnumberrequired
progressobjectrequired
progress.​forms_requirednumberrequired
progress.​forms_completednumberrequired
form_requirementsArray of objectsrequired
form_requirements[].​task_idstring or nullrequired
form_requirements[].​formobjectrequired
form_requirements[].​form.​idstringrequired
form_requirements[].​form.​namestringrequired
form_requirements[].​form.​tagsArray of objectsrequired
form_requirements[].​form.​tags[].​namestringrequired
form_requirements[].​form.​custom_attributesobjectrequired

Custom attribute values

created_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "employee_id": "string",
  "employer_id": "string",
  "client_id": "string",
  "job_id": "string",
  "custom_attributes": {},
  "missing_task_count": 0,
  "progress": {
    "forms_required": 0,
    "forms_completed": 0
  },
  "form_requirements": [
    { … }
  ],
  "created_at": "2019-08-24T14:15:22Z"
}

Get a placement by id

Request

Security
bearerAuth
Path
idstringrequired
curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/placements/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json
idstringrequired
employee_idstringrequired
employer_idstring or nullrequired
client_idstring or nullrequired
job_idstring or nullrequired
custom_attributesobjectrequired

Custom attribute values

missing_task_countnumberrequired
progressobjectrequired
progress.​forms_requirednumberrequired
progress.​forms_completednumberrequired
form_requirementsArray of objectsrequired
form_requirements[].​task_idstring or nullrequired
form_requirements[].​formobjectrequired
form_requirements[].​form.​idstringrequired
form_requirements[].​form.​namestringrequired
form_requirements[].​form.​tagsArray of objectsrequired
form_requirements[].​form.​tags[].​namestringrequired
form_requirements[].​form.​custom_attributesobjectrequired

Custom attribute values

created_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "employee_id": "string",
  "employer_id": "string",
  "client_id": "string",
  "job_id": "string",
  "custom_attributes": {},
  "missing_task_count": 0,
  "progress": {
    "forms_required": 0,
    "forms_completed": 0
  },
  "form_requirements": [
    { … }
  ],
  "created_at": "2019-08-24T14:15:22Z"
}

Update a placement

Request

Security
bearerAuth
Path
idstringrequired
Bodyapplication/json

Body

custom_attributesobject or null

Custom attributes

create_tasksboolean

Create tasks for this placement

property name*anyadditional property
curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/placements/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_attributes": {},
    "create_tasks": true
  }'

Responses

200

Bodyapplication/json
idstringrequired
employee_idstringrequired
employer_idstring or nullrequired
client_idstring or nullrequired
job_idstring or nullrequired
custom_attributesobjectrequired

Custom attribute values

missing_task_countnumberrequired
progressobjectrequired
progress.​forms_requirednumberrequired
progress.​forms_completednumberrequired
suggested_tasksArray of objectsrequired
suggested_tasks[].​form_idstringrequired
suggested_tasks[].​form_namestringrequired
suggested_tasks[].​task_idstring or nullrequired
suggested_tasks[].​form_tagsArray of objectsrequired
suggested_tasks[].​form_tags[].​namestringrequired
form_requirementsArray of objectsrequired
form_requirements[].​task_idstring or nullrequired
form_requirements[].​formobjectrequired
form_requirements[].​form.​idstringrequired
form_requirements[].​form.​namestringrequired
form_requirements[].​form.​tagsArray of objectsrequired
form_requirements[].​form.​tags[].​namestringrequired
form_requirements[].​form.​custom_attributesobjectrequired

Custom attribute values

created_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "employee_id": "string",
  "employer_id": "string",
  "client_id": "string",
  "job_id": "string",
  "custom_attributes": {},
  "missing_task_count": 0,
  "progress": {
    "forms_required": 0,
    "forms_completed": 0
  },
  "suggested_tasks": [
    { … }
  ],
  "form_requirements": [
    { … }
  ],
  "created_at": "2019-08-24T14:15:22Z"
}

Delete a placement by id

Request

Security
bearerAuth
Path
idstringrequired
curl -i -X DELETE \
  'https://docs.onboarded.com/_mock/openapi/api/v1/placements/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json
idstringrequired
employee_idstringrequired
employer_idstring or nullrequired
client_idstring or nullrequired
job_idstring or nullrequired
custom_attributesobjectrequired

Custom attribute values

missing_task_countnumberrequired
progressobjectrequired
progress.​forms_requirednumberrequired
progress.​forms_completednumberrequired
form_requirementsArray of objectsrequired
form_requirements[].​task_idstring or nullrequired
form_requirements[].​formobjectrequired
form_requirements[].​form.​idstringrequired
form_requirements[].​form.​namestringrequired
form_requirements[].​form.​tagsArray of objectsrequired
form_requirements[].​form.​tags[].​namestringrequired
form_requirements[].​form.​custom_attributesobjectrequired

Custom attribute values

created_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "employee_id": "string",
  "employer_id": "string",
  "client_id": "string",
  "job_id": "string",
  "custom_attributes": {},
  "missing_task_count": 0,
  "progress": {
    "forms_required": 0,
    "forms_completed": 0
  },
  "form_requirements": [
    { … }
  ],
  "created_at": "2019-08-24T14:15:22Z"
}

List all placements

Request

Security
bearerAuth
Query
pagenumber>= 1
Default 1
per_pagenumber[ 1 .. 300 ]
Default 20
employee_idstring
employer_idstring
client_idstring
job_idstring
curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/placements?page=1&per_page=20&employee_id=string&employer_id=string&client_id=string&job_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json
dataArray of objectsrequired
data[].​idstringrequired
data[].​employee_idstringrequired
data[].​employer_idstring or nullrequired
data[].​client_idstring or nullrequired
data[].​job_idstring or nullrequired
data[].​custom_attributesobjectrequired

Custom attribute values

data[].​missing_task_countnumberrequired
data[].​progressobjectrequired
data[].​progress.​forms_requirednumberrequired
data[].​progress.​forms_completednumberrequired
data[].​form_requirementsArray of objectsrequired
data[].​form_requirements[].​task_idstring or nullrequired
data[].​form_requirements[].​formobjectrequired
data[].​form_requirements[].​form.​idstringrequired
data[].​form_requirements[].​form.​namestringrequired
data[].​form_requirements[].​form.​tagsArray of objectsrequired
data[].​form_requirements[].​form.​tags[].​namestringrequired
data[].​form_requirements[].​form.​custom_attributesobjectrequired

Custom attribute values

data[].​created_atstring(date-time)required
totalnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "total": 0
}

Create an placement

Request

Security
bearerAuth
Bodyapplication/json

Body

employee_idstringrequired
employer_idstring or null
client_idstring or null
job_idstring or null
custom_attributesobject or null

Custom attributes

create_tasksboolean or null

Create tasks for this placement

property name*anyadditional property
curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/placements \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "employee_id": "string",
    "employer_id": "string",
    "client_id": "string",
    "job_id": "string",
    "custom_attributes": {},
    "create_tasks": true
  }'

Responses

201

Bodyapplication/json
idstringrequired
employee_idstringrequired
employer_idstring or nullrequired
client_idstring or nullrequired
job_idstring or nullrequired
custom_attributesobjectrequired

Custom attribute values

missing_task_countnumberrequired
progressobjectrequired
progress.​forms_requirednumberrequired
progress.​forms_completednumberrequired
form_requirementsArray of objectsrequired
form_requirements[].​task_idstring or nullrequired
form_requirements[].​formobjectrequired
form_requirements[].​form.​idstringrequired
form_requirements[].​form.​namestringrequired
form_requirements[].​form.​tagsArray of objectsrequired
form_requirements[].​form.​tags[].​namestringrequired
form_requirements[].​form.​custom_attributesobjectrequired

Custom attribute values

created_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "employee_id": "string",
  "employer_id": "string",
  "client_id": "string",
  "job_id": "string",
  "custom_attributes": {},
  "missing_task_count": 0,
  "progress": {
    "forms_required": 0,
    "forms_completed": 0
  },
  "form_requirements": [
    { … }
  ],
  "created_at": "2019-08-24T14:15:22Z"
}

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

Users

Users APIs

Operations

Webhooks

Webhooks APIs

Operations