API Reference

Get a task's fields

Onboarded API (0.0.1)

Download OpenAPI description

openapi.json

openapi.yaml

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

Tasks

Tasks APIs

Operations

List all tasks

Request

Security

bearerAuth

Query

pagenumber>= 1

Default 1

per_pagenumber[ 1 .. 300 ]

Default 20

employee_idstring

employer_idstring

client_idstring

job_idstring

expired_at_ltestring or null(date-time)

Query tasks by expiration time. Tasks with expiration time equal or earlier than the provided timestamp are returned.

expired_at_gtestring or null(date-time)

Query tasks by expiration time. Tasks with expiration time equal or later than the provided timestamp are returned.

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/tasks?client_id=string&employee_id=string&employer_id=string&expired_at_gte=2019-08-24T14%3A15%3A22Z&expired_at_lte=2019-08-24T14%3A15%3A22Z&job_id=string&page=1&per_page=20' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json

dataArray of objectsrequired

data[].idstringrequired

data[].form_idstringrequired

data[].form_custom_attributesobjectrequired

Custom attribute values

data[].namestringrequired

Name of the form.

data[].employee_idstringrequired

data[].employer_idstring or nullrequired

data[].client_idstring or nullrequired

data[].job_idstring or nullrequired

data[].statusstringrequired

Enum"requires_action""completed""expired"

data[].next_actionobjectrequired

data[].next_action.typestring or nullrequired

Enum"employer_action""employee_action""system_action"

data[].expired_atstring or null(date-time)required

Expiration time is re-evaluated at the time of task completion. If your integration reads the field value before a task is completed, please note that the value may change when the task is completed.

data[].due_atstring or null(date-time)required

data[].progressobjectrequired

data[].progress.percentnumberrequired

data[].progress.numeratornumberrequired

data[].progress.denominatornumberrequired

data[].subtasksArray of objectsrequired

data[].subtasks[].idstringrequired

data[].subtasks[].form_page_idstringrequired

data[].subtasks[].assignee_typestringrequired

Enum"employee""employer"

data[].subtasks[].progressobjectrequired

data[].subtasks[].progress.percentnumberrequired

data[].subtasks[].progress.numeratornumberrequired

data[].subtasks[].progress.denominatornumberrequired

data[].tagsArray of objectsrequired

data[].tags[].namestringrequired

data[].created_atstring(date-time)required

data[].updated_atstring(date-time)required

totalnumberrequired

Response

application/json

{
  "data": [
    { … }
  ],
  "total": 0
}

Create a task

Request

Security

bearerAuth

Query

allow_duplicateboolean or null

Bodyapplication/json

Body

form_idstringrequired

employee_idstringrequired

employer_idstring or null

client_idstring or null

job_idstring or null

placement_idstring or null

Tasks are designed to be reusable across multiple placements. However, if your form uses placement attribute scoping, you must provide a placement id here so that Onboarded can retrieve the scoped value from your placement.

expired_atstring or null(date-time)

Datetime for when the task expires. If not included in the request payload, default value from the form will be used (when applicable). Set this property to null if you do not want this task to inherit form default expiration time.

due_atstring or null(date-time)

Datetime for when the task is due. If not included in the request payload, default value from the form will be used (when applicable). Set this property to null if you do not want this task to inherit form default due time.

curl -i -X POST \
  'https://docs.onboarded.com/_mock/openapi/api/v1/tasks?allow_duplicate=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "form_id": "string",
    "employee_id": "string",
    "employer_id": "string",
    "client_id": "string",
    "job_id": "string",
    "placement_id": "string",
    "expired_at": "2019-08-24T14:15:22Z",
    "due_at": "2019-08-24T14:15:22Z"
  }'

Responses

201

Bodyapplication/json

idstringrequired

form_idstringrequired

form_custom_attributesobjectrequired

Custom attribute values

namestringrequired

Name of the form.

employee_idstringrequired

employer_idstring or nullrequired

client_idstring or nullrequired

job_idstring or nullrequired

statusstringrequired

Enum"requires_action""completed""expired"

next_actionobjectrequired

next_action.typestring or nullrequired

Enum"employer_action""employee_action""system_action"

expired_atstring or null(date-time)required

Expiration time is re-evaluated at the time of task completion. If your integration reads the field value before a task is completed, please note that the value may change when the task is completed.

due_atstring or null(date-time)required

progressobjectrequired

progress.percentnumberrequired

progress.numeratornumberrequired

progress.denominatornumberrequired

subtasksArray of objectsrequired

subtasks[].idstringrequired

subtasks[].form_page_idstringrequired

subtasks[].assignee_typestringrequired

Enum"employee""employer"

subtasks[].progressobjectrequired

subtasks[].progress.percentnumberrequired

subtasks[].progress.numeratornumberrequired

subtasks[].progress.denominatornumberrequired

tagsArray of objectsrequired

tags[].namestringrequired

created_atstring(date-time)required

updated_atstring(date-time)required

Response

application/json

{
  "id": "string",
  "form_id": "string",
  "form_custom_attributes": {},
  "name": "string",
  "employee_id": "string",
  "employer_id": "string",
  "client_id": "string",
  "job_id": "string",
  "status": "requires_action",
  "next_action": {
    "type": "employer_action"
  },
  "expired_at": "2019-08-24T14:15:22Z",
  "due_at": "2019-08-24T14:15:22Z",
  "progress": {
    "percent": 0,
    "numerator": 0,
    "denominator": 0
  },
  "subtasks": [
    { … }
  ],
  "tags": [
    { … }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Get a task

Request

Security

bearerAuth

Path

idstringrequired

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

Responses

200

Bodyapplication/json

idstringrequired

form_idstringrequired

form_custom_attributesobjectrequired

Custom attribute values

namestringrequired

Name of the form.

employee_idstringrequired

employer_idstring or nullrequired

client_idstring or nullrequired

job_idstring or nullrequired

statusstringrequired

Enum"requires_action""completed""expired"

next_actionobjectrequired

next_action.typestring or nullrequired

Enum"employer_action""employee_action""system_action"

expired_atstring or null(date-time)required

Expiration time is re-evaluated at the time of task completion. If your integration reads the field value before a task is completed, please note that the value may change when the task is completed.

due_atstring or null(date-time)required

progressobjectrequired

progress.percentnumberrequired

progress.numeratornumberrequired

progress.denominatornumberrequired

subtasksArray of objectsrequired

subtasks[].idstringrequired

subtasks[].form_page_idstringrequired

subtasks[].assignee_typestringrequired

Enum"employee""employer"

subtasks[].progressobjectrequired

subtasks[].progress.percentnumberrequired

subtasks[].progress.numeratornumberrequired

subtasks[].progress.denominatornumberrequired

tagsArray of objectsrequired

tags[].namestringrequired

created_atstring(date-time)required

updated_atstring(date-time)required

Response

application/json

{
  "id": "string",
  "form_id": "string",
  "form_custom_attributes": {},
  "name": "string",
  "employee_id": "string",
  "employer_id": "string",
  "client_id": "string",
  "job_id": "string",
  "status": "requires_action",
  "next_action": {
    "type": "employer_action"
  },
  "expired_at": "2019-08-24T14:15:22Z",
  "due_at": "2019-08-24T14:15:22Z",
  "progress": {
    "percent": 0,
    "numerator": 0,
    "denominator": 0
  },
  "subtasks": [
    { … }
  ],
  "tags": [
    { … }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update a task

Request

Security

bearerAuth

Path

idstringrequired

Bodyapplication/json

Body

expired_atstring or null(date-time)

When the form has its own expiration settings, the effective expired_at of a task is set to the earliest time between task expired_at and the form's expiration settings.

curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/tasks/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "expired_at": "2019-08-24T14:15:22Z"
  }'

Responses

200

Bodyapplication/json

idstringrequired

form_idstringrequired

form_custom_attributesobjectrequired

Custom attribute values

namestringrequired

Name of the form.

employee_idstringrequired

employer_idstring or nullrequired

client_idstring or nullrequired

job_idstring or nullrequired

statusstringrequired

Enum"requires_action""completed""expired"

next_actionobjectrequired

next_action.typestring or nullrequired

Enum"employer_action""employee_action""system_action"

expired_atstring or null(date-time)required

Expiration time is re-evaluated at the time of task completion. If your integration reads the field value before a task is completed, please note that the value may change when the task is completed.

due_atstring or null(date-time)required

progressobjectrequired

progress.percentnumberrequired

progress.numeratornumberrequired

progress.denominatornumberrequired

subtasksArray of objectsrequired

subtasks[].idstringrequired

subtasks[].form_page_idstringrequired

subtasks[].assignee_typestringrequired

Enum"employee""employer"

subtasks[].progressobjectrequired

subtasks[].progress.percentnumberrequired

subtasks[].progress.numeratornumberrequired

subtasks[].progress.denominatornumberrequired

tagsArray of objectsrequired

tags[].namestringrequired

created_atstring(date-time)required

updated_atstring(date-time)required

Response

application/json

{
  "id": "string",
  "form_id": "string",
  "form_custom_attributes": {},
  "name": "string",
  "employee_id": "string",
  "employer_id": "string",
  "client_id": "string",
  "job_id": "string",
  "status": "requires_action",
  "next_action": {
    "type": "employer_action"
  },
  "expired_at": "2019-08-24T14:15:22Z",
  "due_at": "2019-08-24T14:15:22Z",
  "progress": {
    "percent": 0,
    "numerator": 0,
    "denominator": 0
  },
  "subtasks": [
    { … }
  ],
  "tags": [
    { … }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Delete a task

Request

Security

bearerAuth

Path

idstringrequired

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

Responses

200

Bodyapplication/json

idstringrequired

form_idstringrequired

form_custom_attributesobjectrequired

Custom attribute values

namestringrequired

Name of the form.

employee_idstringrequired

employer_idstring or nullrequired

client_idstring or nullrequired

job_idstring or nullrequired

statusstringrequired

Enum"requires_action""completed""expired"

next_actionobjectrequired

next_action.typestring or nullrequired

Enum"employer_action""employee_action""system_action"

expired_atstring or null(date-time)required

Expiration time is re-evaluated at the time of task completion. If your integration reads the field value before a task is completed, please note that the value may change when the task is completed.

due_atstring or null(date-time)required

progressobjectrequired

progress.percentnumberrequired

progress.numeratornumberrequired

progress.denominatornumberrequired

subtasksArray of objectsrequired

subtasks[].idstringrequired

subtasks[].form_page_idstringrequired

subtasks[].assignee_typestringrequired

Enum"employee""employer"

subtasks[].progressobjectrequired

subtasks[].progress.percentnumberrequired

subtasks[].progress.numeratornumberrequired

subtasks[].progress.denominatornumberrequired

tagsArray of objectsrequired

tags[].namestringrequired

created_atstring(date-time)required

updated_atstring(date-time)required

Response

application/json

{
  "id": "string",
  "form_id": "string",
  "form_custom_attributes": {},
  "name": "string",
  "employee_id": "string",
  "employer_id": "string",
  "client_id": "string",
  "job_id": "string",
  "status": "requires_action",
  "next_action": {
    "type": "employer_action"
  },
  "expired_at": "2019-08-24T14:15:22Z",
  "due_at": "2019-08-24T14:15:22Z",
  "progress": {
    "percent": 0,
    "numerator": 0,
    "denominator": 0
  },
  "subtasks": [
    { … }
  ],
  "tags": [
    { … }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Get a task's fields

Request

Security

bearerAuth

Path

idstringrequired

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/tasks/{id}/fields' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json

fieldsArray of objectsrequired

fields[].typestringrequired

fields[].pathstringrequired

fields[].labelobjectrequired

fields[].label.enstring or nullrequired

Label for the field, in english (if available)

fields[].valueany

The value of the field

Response

application/json

{
  "fields": [
    { … }
  ]
}

Update a task's fields

Request

Security

bearerAuth

Path

idstringrequired

Bodyapplication/json

Body

fieldsArray of objectsrequired

fields[].pathstringrequired

fields[].valueany

The value of the field

curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/tasks/{id}/fields' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "fields": [
      {
        "path": "string",
        "value": null
      }
    ]
  }'

Responses

200

Response

No content

Get a task pdf

Request

Security

bearerAuth

Path

idstringrequired

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/tasks/{id}/pdf' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json

string(binary)

Response

application/json

"string"

Get a task onboarding url

Request

Security

bearerAuth

Path

idstringrequired

Query

assignee_typestringrequired

Enum"employee""employer"

localestring= 2 characters

Locale code (e.g. en, es, fr)

Default "en"

redirect_tostring(uri)

Redirect to url to send the user after onboarding is complete

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/tasks/{id}/onboarding?assignee_type=employee&locale=en&redirect_to=http%3A%2F%2Fexample.com' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json

urlstringrequired

Response

application/json

{
  "url": "string"
}

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

Onboarded API (0.0.1)

Components

Employees

Employers

Clients

Jobs

Placements

Tasks

List all tasks

Request

Responses

Was this helpful?

Create a task

Request

Responses

Was this helpful?

Get a task

Request

Responses

Was this helpful?

Update a task

Request

Responses

Was this helpful?

Delete a task

Request

Responses

Was this helpful?

Get a task's fields

Request

Responses

Was this helpful?

Update a task's fields

RequestExpand all

Responses

Was this helpful?

Get a task pdf

Request

Responses

Was this helpful?

Get a task onboarding url

Request

Responses

Was this helpful?

Task Change Requests

Forms

Files

Themes

Custom Properties

Request