Skip to content
API Reference
/
/
placements.preview

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

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

List all placements

Request

Security
user_session or form_session or component_session or component_token or api_token
Query
pagestring(between(1, 1000))

a number between 1 and 1000

per_pagestring(between(1, 100))

a number between 1 and 100

employee_idstring(EmployeeId)^ee_

Employee Identifier

employer_idstring(EmployerId)^er_

Employer Identifier

client_idstring(ClientId)^cl_

Client Identifier

job_idstring(JobId)^job_

Job Identifier

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/placements?page=string&per_page=string&employee_id=ee_abc123def456&employer_id=er_abc123def456&client_id=cl_abc123def456&job_id=job_abc123def456' \
  -b __session=YOUR_API_KEY_HERE

Responses

Success

Bodyapplication/json
dataArray of objects(Placement)required
data[].​idstring(PlacementId)^pla_required

Placement Identifier

data[].​employee_idstring(EmployeeId)^ee_required

Employee Identifier

data[].​employer_idEmployerId (string) or nullrequired
Any of:

Employer Identifier

string(EmployerId)^er_
data[].​client_idClientId (string) or nullrequired
Any of:

Client Identifier

string(ClientId)^cl_
data[].​job_idJobId (string) or nullrequired
Any of:

Job Identifier

string(JobId)^job_
data[].​custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

data[].​created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

data[].​missing_task_countnumberrequired
data[].​progressobjectrequired
data[].​progress.​forms_requirednumberrequired
data[].​progress.​forms_completednumberrequired
data[].​form_requirementsArray of objectsrequired
data[].​form_requirements[].​task_idTaskId (string) or nullrequired
Any of:

Task Identifier

string(TaskId)^task_
data[].​form_requirements[].​formobjectrequired
data[].​form_requirements[].​form.​idstring(FormId)required

Form Identifier (lineage uid)

data[].​form_requirements[].​form.​namestringrequired
data[].​form_requirements[].​form.​tagsArray of objectsrequired
data[].​form_requirements[].​form.​tags[].​namestringrequired
data[].​form_requirements[].​form.​custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

data[].​form_requirements[].​form_idstring(FormId)required

Form Identifier (lineage uid)

data[].​form_requirements[].​form_namestringrequired
data[].​form_requirements[].​form_tagsArray of objectsrequired
data[].​form_requirements[].​form_tags[].​namestringrequired
data[].​suggested_tasksArray of objectsrequired
data[].​suggested_tasks[].​form_idstring(FormId)required

Form Identifier (lineage uid)

data[].​suggested_tasks[].​form_namestringrequired
data[].​suggested_tasks[].​task_idTaskId (string) or nullrequired
Any of:

Task Identifier

string(TaskId)^task_
data[].​suggested_tasks[].​form_tagsArray of objectsrequired
data[].​suggested_tasks[].​form_tags[].​namestringrequired
data[].​property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

totalnumberrequired
current_pagenumberrequired
per_pagenumberrequired
total_pagesnumber
Response
application/json
{
  "data": [
    { … }
  ],
  "total": 0,
  "current_page": 0,
  "per_page": 0,
  "total_pages": 0
}

Create a new placement

Request

Security
user_session or form_session or component_session or component_token or api_token
Bodyapplication/jsonrequired
employee_idstring(EmployeeId)^ee_required

Employee Identifier

employer_id(EmployerId (string) or null) or null
Any of:
Any of:

Employer Identifier

string(EmployerId)^er_
client_id(ClientId (string) or null) or null
Any of:
Any of:

Client Identifier

string(ClientId)^cl_
job_id(JobId (string) or null) or null
Any of:
Any of:

Job Identifier

string(JobId)^job_
custom_attributesobject(CustomAttributes)

Record of custom attribute values keyed by string path.

create_tasksboolean
property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/placements \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "employee_id": "ee_abc123def456",
    "employer_id": "er_abc123def456",
    "client_id": "cl_abc123def456",
    "job_id": "job_abc123def456",
    "custom_attributes": {
      "property1": null,
      "property2": null
    },
    "create_tasks": true,
    "property1": null,
    "property2": null
  }'

Responses

A placement with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base placement schema.

Bodyapplication/json
idstring(PlacementId)^pla_required

Placement Identifier

employee_idstring(EmployeeId)^ee_required

Employee Identifier

employer_idEmployerId (string) or nullrequired
Any of:

Employer Identifier

string(EmployerId)^er_
client_idClientId (string) or nullrequired
Any of:

Client Identifier

string(ClientId)^cl_
job_idJobId (string) or nullrequired
Any of:

Job Identifier

string(JobId)^job_
custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

missing_task_countnumberrequired
progressobjectrequired
progress.​forms_requirednumberrequired
progress.​forms_completednumberrequired
form_requirementsArray of objectsrequired
form_requirements[].​task_idTaskId (string) or nullrequired
Any of:

Task Identifier

string(TaskId)^task_
form_requirements[].​formobjectrequired
form_requirements[].​form.​idstring(FormId)required

Form Identifier (lineage uid)

form_requirements[].​form.​namestringrequired
form_requirements[].​form.​tagsArray of objectsrequired
form_requirements[].​form.​tags[].​namestringrequired
form_requirements[].​form.​custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

form_requirements[].​form_idstring(FormId)required

Form Identifier (lineage uid)

form_requirements[].​form_namestringrequired
form_requirements[].​form_tagsArray of objectsrequired
form_requirements[].​form_tags[].​namestringrequired
suggested_tasksArray of objectsrequired
suggested_tasks[].​form_idstring(FormId)required

Form Identifier (lineage uid)

suggested_tasks[].​form_namestringrequired
suggested_tasks[].​task_idTaskId (string) or nullrequired
Any of:

Task Identifier

string(TaskId)^task_
suggested_tasks[].​form_tagsArray of objectsrequired
suggested_tasks[].​form_tags[].​namestringrequired
property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response
application/json
{
  "id": "pla_abc123def456",
  "employee_id": "ee_abc123def456",
  "employer_id": "er_abc123def456",
  "client_id": "cl_abc123def456",
  "job_id": "job_abc123def456",
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "missing_task_count": 0,
  "progress": {
    "forms_required": 0,
    "forms_completed": 0
  },
  "form_requirements": [
    { … }
  ],
  "suggested_tasks": [
    { … }
  ],
  "property1": null,
  "property2": null
}

Get a placement by ID

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
placement_idstring(PlacementId)^pla_required

Placement Identifier

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

Responses

A placement with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base placement schema.

Bodyapplication/json
idstring(PlacementId)^pla_required

Placement Identifier

employee_idstring(EmployeeId)^ee_required

Employee Identifier

employer_idEmployerId (string) or nullrequired
Any of:

Employer Identifier

string(EmployerId)^er_
client_idClientId (string) or nullrequired
Any of:

Client Identifier

string(ClientId)^cl_
job_idJobId (string) or nullrequired
Any of:

Job Identifier

string(JobId)^job_
custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

missing_task_countnumberrequired
progressobjectrequired
progress.​forms_requirednumberrequired
progress.​forms_completednumberrequired
form_requirementsArray of objectsrequired
form_requirements[].​task_idTaskId (string) or nullrequired
Any of:

Task Identifier

string(TaskId)^task_
form_requirements[].​formobjectrequired
form_requirements[].​form.​idstring(FormId)required

Form Identifier (lineage uid)

form_requirements[].​form.​namestringrequired
form_requirements[].​form.​tagsArray of objectsrequired
form_requirements[].​form.​tags[].​namestringrequired
form_requirements[].​form.​custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

form_requirements[].​form_idstring(FormId)required

Form Identifier (lineage uid)

form_requirements[].​form_namestringrequired
form_requirements[].​form_tagsArray of objectsrequired
form_requirements[].​form_tags[].​namestringrequired
suggested_tasksArray of objectsrequired
suggested_tasks[].​form_idstring(FormId)required

Form Identifier (lineage uid)

suggested_tasks[].​form_namestringrequired
suggested_tasks[].​task_idTaskId (string) or nullrequired
Any of:

Task Identifier

string(TaskId)^task_
suggested_tasks[].​form_tagsArray of objectsrequired
suggested_tasks[].​form_tags[].​namestringrequired
property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response
application/json
{
  "id": "pla_abc123def456",
  "employee_id": "ee_abc123def456",
  "employer_id": "er_abc123def456",
  "client_id": "cl_abc123def456",
  "job_id": "job_abc123def456",
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "missing_task_count": 0,
  "progress": {
    "forms_required": 0,
    "forms_completed": 0
  },
  "form_requirements": [
    { … }
  ],
  "suggested_tasks": [
    { … }
  ],
  "property1": null,
  "property2": null
}

Update a placement

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
placement_idstring(PlacementId)^pla_required

Placement Identifier

Bodyapplication/jsonrequired
custom_attributesobject(CustomAttributes)

Record of custom attribute values keyed by string path.

create_tasksboolean
property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/placements/{placement_id}' \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "custom_attributes": {
      "property1": null,
      "property2": null
    },
    "create_tasks": true,
    "property1": null,
    "property2": null
  }'

Responses

A placement with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base placement schema.

Bodyapplication/json
idstring(PlacementId)^pla_required

Placement Identifier

employee_idstring(EmployeeId)^ee_required

Employee Identifier

employer_idEmployerId (string) or nullrequired
Any of:

Employer Identifier

string(EmployerId)^er_
client_idClientId (string) or nullrequired
Any of:

Client Identifier

string(ClientId)^cl_
job_idJobId (string) or nullrequired
Any of:

Job Identifier

string(JobId)^job_
custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

missing_task_countnumberrequired
progressobjectrequired
progress.​forms_requirednumberrequired
progress.​forms_completednumberrequired
form_requirementsArray of objectsrequired
form_requirements[].​task_idTaskId (string) or nullrequired
Any of:

Task Identifier

string(TaskId)^task_
form_requirements[].​formobjectrequired
form_requirements[].​form.​idstring(FormId)required

Form Identifier (lineage uid)

form_requirements[].​form.​namestringrequired
form_requirements[].​form.​tagsArray of objectsrequired
form_requirements[].​form.​tags[].​namestringrequired
form_requirements[].​form.​custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

form_requirements[].​form_idstring(FormId)required

Form Identifier (lineage uid)

form_requirements[].​form_namestringrequired
form_requirements[].​form_tagsArray of objectsrequired
form_requirements[].​form_tags[].​namestringrequired
suggested_tasksArray of objectsrequired
suggested_tasks[].​form_idstring(FormId)required

Form Identifier (lineage uid)

suggested_tasks[].​form_namestringrequired
suggested_tasks[].​task_idTaskId (string) or nullrequired
Any of:

Task Identifier

string(TaskId)^task_
suggested_tasks[].​form_tagsArray of objectsrequired
suggested_tasks[].​form_tags[].​namestringrequired
property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response
application/json
{
  "id": "pla_abc123def456",
  "employee_id": "ee_abc123def456",
  "employer_id": "er_abc123def456",
  "client_id": "cl_abc123def456",
  "job_id": "job_abc123def456",
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "missing_task_count": 0,
  "progress": {
    "forms_required": 0,
    "forms_completed": 0
  },
  "form_requirements": [
    { … }
  ],
  "suggested_tasks": [
    { … }
  ],
  "property1": null,
  "property2": null
}

Delete a placement

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
placement_idstring(PlacementId)^pla_required

Placement Identifier

curl -i -X DELETE \
  'https://docs.onboarded.com/_mock/openapi/api/v1/placements/{placement_id}' \
  -b __session=YOUR_API_KEY_HERE

Responses

A placement with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base placement schema.

Bodyapplication/json
idstring(PlacementId)^pla_required

Placement Identifier

employee_idstring(EmployeeId)^ee_required

Employee Identifier

employer_idEmployerId (string) or nullrequired
Any of:

Employer Identifier

string(EmployerId)^er_
client_idClientId (string) or nullrequired
Any of:

Client Identifier

string(ClientId)^cl_
job_idJobId (string) or nullrequired
Any of:

Job Identifier

string(JobId)^job_
custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

missing_task_countnumberrequired
progressobjectrequired
progress.​forms_requirednumberrequired
progress.​forms_completednumberrequired
form_requirementsArray of objectsrequired
form_requirements[].​task_idTaskId (string) or nullrequired
Any of:

Task Identifier

string(TaskId)^task_
form_requirements[].​formobjectrequired
form_requirements[].​form.​idstring(FormId)required

Form Identifier (lineage uid)

form_requirements[].​form.​namestringrequired
form_requirements[].​form.​tagsArray of objectsrequired
form_requirements[].​form.​tags[].​namestringrequired
form_requirements[].​form.​custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

form_requirements[].​form_idstring(FormId)required

Form Identifier (lineage uid)

form_requirements[].​form_namestringrequired
form_requirements[].​form_tagsArray of objectsrequired
form_requirements[].​form_tags[].​namestringrequired
suggested_tasksArray of objectsrequired
suggested_tasks[].​form_idstring(FormId)required

Form Identifier (lineage uid)

suggested_tasks[].​form_namestringrequired
suggested_tasks[].​task_idTaskId (string) or nullrequired
Any of:

Task Identifier

string(TaskId)^task_
suggested_tasks[].​form_tagsArray of objectsrequired
suggested_tasks[].​form_tags[].​namestringrequired
property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response
application/json
{
  "id": "pla_abc123def456",
  "employee_id": "ee_abc123def456",
  "employer_id": "er_abc123def456",
  "client_id": "cl_abc123def456",
  "job_id": "job_abc123def456",
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "missing_task_count": 0,
  "progress": {
    "forms_required": 0,
    "forms_completed": 0
  },
  "form_requirements": [
    { … }
  ],
  "suggested_tasks": [
    { … }
  ],
  "property1": null,
  "property2": null
}

placements.preview

Request

Generate a transient placement to preview form requirements without creating it

Security
user_session or form_session or component_session or component_token or api_token
Bodyapplication/jsonrequired
employee_idstring(EmployeeId)^ee_required

Employee Identifier

employer_id(EmployerId (string) or null) or null
Any of:
Any of:

Employer Identifier

string(EmployerId)^er_
client_id(ClientId (string) or null) or null
Any of:
Any of:

Client Identifier

string(ClientId)^cl_
job_id(JobId (string) or null) or null
Any of:
Any of:

Job Identifier

string(JobId)^job_
custom_attributesobject(CustomAttributes)

Record of custom attribute values keyed by string path.

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/placements/preview \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "employee_id": "ee_abc123def456",
    "employer_id": "er_abc123def456",
    "client_id": "cl_abc123def456",
    "job_id": "job_abc123def456",
    "custom_attributes": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  }'

Responses

A placement with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base placement schema.

Bodyapplication/json
idstring(PlacementId)^pla_required

Placement Identifier

employee_idstring(EmployeeId)^ee_required

Employee Identifier

employer_idEmployerId (string) or nullrequired
Any of:

Employer Identifier

string(EmployerId)^er_
client_idClientId (string) or nullrequired
Any of:

Client Identifier

string(ClientId)^cl_
job_idJobId (string) or nullrequired
Any of:

Job Identifier

string(JobId)^job_
custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

missing_task_countnumberrequired
progressobjectrequired
progress.​forms_requirednumberrequired
progress.​forms_completednumberrequired
form_requirementsArray of objectsrequired
form_requirements[].​task_idTaskId (string) or nullrequired
Any of:

Task Identifier

string(TaskId)^task_
form_requirements[].​formobjectrequired
form_requirements[].​form.​idstring(FormId)required

Form Identifier (lineage uid)

form_requirements[].​form.​namestringrequired
form_requirements[].​form.​tagsArray of objectsrequired
form_requirements[].​form.​tags[].​namestringrequired
form_requirements[].​form.​custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

form_requirements[].​form_idstring(FormId)required

Form Identifier (lineage uid)

form_requirements[].​form_namestringrequired
form_requirements[].​form_tagsArray of objectsrequired
form_requirements[].​form_tags[].​namestringrequired
suggested_tasksArray of objectsrequired
suggested_tasks[].​form_idstring(FormId)required

Form Identifier (lineage uid)

suggested_tasks[].​form_namestringrequired
suggested_tasks[].​task_idTaskId (string) or nullrequired
Any of:

Task Identifier

string(TaskId)^task_
suggested_tasks[].​form_tagsArray of objectsrequired
suggested_tasks[].​form_tags[].​namestringrequired
property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response
application/json
{
  "id": "pla_abc123def456",
  "employee_id": "ee_abc123def456",
  "employer_id": "er_abc123def456",
  "client_id": "cl_abc123def456",
  "job_id": "job_abc123def456",
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "missing_task_count": 0,
  "progress": {
    "forms_required": 0,
    "forms_completed": 0
  },
  "form_requirements": [
    { … }
  ],
  "suggested_tasks": [
    { … }
  ],
  "property1": null,
  "property2": null
}

placements.previewDeprecatedDeprecated

Request

DEPRECATED: Use POST /placements/preview instead

Security
user_session or form_session or component_session or component_token or api_token
Query
employee_idstring(EmployeeId)^ee_required

Employee Identifier

employer_idstring(EmployerId)^er_

Employer Identifier

client_idstring(ClientId)^cl_

Client Identifier

job_idstring(JobId)^job_

Job Identifier

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/placements/preview?employee_id=ee_abc123def456&employer_id=er_abc123def456&client_id=cl_abc123def456&job_id=job_abc123def456' \
  -b __session=YOUR_API_KEY_HERE

Responses

A placement with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base placement schema.

Bodyapplication/json
idstring(PlacementId)^pla_required

Placement Identifier

employee_idstring(EmployeeId)^ee_required

Employee Identifier

employer_idEmployerId (string) or nullrequired
Any of:

Employer Identifier

string(EmployerId)^er_
client_idClientId (string) or nullrequired
Any of:

Client Identifier

string(ClientId)^cl_
job_idJobId (string) or nullrequired
Any of:

Job Identifier

string(JobId)^job_
custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

missing_task_countnumberrequired
progressobjectrequired
progress.​forms_requirednumberrequired
progress.​forms_completednumberrequired
form_requirementsArray of objectsrequired
form_requirements[].​task_idTaskId (string) or nullrequired
Any of:

Task Identifier

string(TaskId)^task_
form_requirements[].​formobjectrequired
form_requirements[].​form.​idstring(FormId)required

Form Identifier (lineage uid)

form_requirements[].​form.​namestringrequired
form_requirements[].​form.​tagsArray of objectsrequired
form_requirements[].​form.​tags[].​namestringrequired
form_requirements[].​form.​custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

form_requirements[].​form_idstring(FormId)required

Form Identifier (lineage uid)

form_requirements[].​form_namestringrequired
form_requirements[].​form_tagsArray of objectsrequired
form_requirements[].​form_tags[].​namestringrequired
suggested_tasksArray of objectsrequired
suggested_tasks[].​form_idstring(FormId)required

Form Identifier (lineage uid)

suggested_tasks[].​form_namestringrequired
suggested_tasks[].​task_idTaskId (string) or nullrequired
Any of:

Task Identifier

string(TaskId)^task_
suggested_tasks[].​form_tagsArray of objectsrequired
suggested_tasks[].​form_tags[].​namestringrequired
property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response
application/json
{
  "id": "pla_abc123def456",
  "employee_id": "ee_abc123def456",
  "employer_id": "er_abc123def456",
  "client_id": "cl_abc123def456",
  "job_id": "job_abc123def456",
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "missing_task_count": 0,
  "progress": {
    "forms_required": 0,
    "forms_completed": 0
  },
  "form_requirements": [
    { … }
  ],
  "suggested_tasks": [
    { … }
  ],
  "property1": null,
  "property2": null
}

placements.previewTasksDeprecated

Request

DEPRECATED: Use POST /placements/preview instead

Security
user_session or form_session or component_session or component_token or api_token
Bodyapplication/jsonrequired
employee_idstring(EmployeeId)^ee_required

Employee Identifier

employer_id(EmployerId (string) or null) or null
Any of:
Any of:

Employer Identifier

string(EmployerId)^er_
client_id(ClientId (string) or null) or null
Any of:
Any of:

Client Identifier

string(ClientId)^cl_
job_id(JobId (string) or null) or null
Any of:
Any of:

Job Identifier

string(JobId)^job_
curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/placements/preview_tasks \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "employee_id": "ee_abc123def456",
    "employer_id": "er_abc123def456",
    "client_id": "cl_abc123def456",
    "job_id": "job_abc123def456"
  }'

Responses

Success

Bodyapplication/jsonArray [
form_idstring(FormId)required

Form Identifier (lineage uid)

namestringrequired
rulesany(unknown)required
]
Response
application/json
[
  {
    "form_id": "tlin_abc123def456",
    "name": "string",
    "rules": null
  }
]

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