Skip to content

Create a new task

Request

Security
form_session or user_session or component_session or component_token or api_token
Query
allow_duplicatestring
Enum:"true""false""True""False"
Bodyapplication/jsonrequired
form_idstring(FormId)required

Form Identifier (lineage uid)

Example:"tlin_abc123def456"
employee_idstring(EmployeeId)^ee_required

Employee Identifier

Example:"ee_abc123def456"
employer_id(EmployerId (string) or null) or null
Any of:
Any of:

Employer Identifier

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

Client Identifier

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

Job Identifier

string(JobId)
placement_id(PlacementId (string) or null) or null
Any of:
Any of:

Placement Identifier

string(PlacementId)
expired_atDateTimeUtc (string) or null
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
due_atDateTimeUtc (string) or null
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
deletion_scheduled_atDateTimeUtc (string) or null
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
deletion_allowed_atDateTimeUtc (string) or null
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
curl -i -X POST \
  'https://docs.onboarded.com/_mock/openapi/api/v1/tasks?allow_duplicate=true' \
  -H 'Authorization: Bearer <YOUR_Onboarded form session token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "form_id": "tlin_abc123def456",
    "employee_id": "ee_abc123def456",
    "employer_id": "er_abc123def456",
    "client_id": "cl_abc123def456",
    "job_id": "job_abc123def456",
    "placement_id": "pla_abc123def456",
    "expired_at": "string",
    "due_at": "string",
    "deletion_scheduled_at": "string",
    "deletion_allowed_at": "string"
  }'

Responses

Task

Bodyapplication/json
idstring(TaskId)^task_required

Task Identifier

Example:"task_abc123def456"
form_idstring(FormId)required

Form Identifier (lineage uid)

Example:"tlin_abc123def456"
form_custom_attributesobjectrequired
namestringrequired

The name of the form

employee_idstring(EmployeeId)^ee_required

Employee Identifier

Example:"ee_abc123def456"
employer_idEmployerId (string) or nullrequired
Any of:

Employer Identifier

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

Client Identifier

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

Job Identifier

string(JobId)
statusstringrequired
Enum:"requires_action""completed""expired"
pdfobjectrequired
next_actionobjectrequired
expired_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
deletion_scheduled_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
deletion_allowed_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
due_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
completed_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
completed_out_of_bandbooleanrequired

Whether the task was completed outside Onboarded rather than through the product. Such tasks support expiration rules, but have no generated task or audit PDF, cannot have change requests, and are excluded from candidate onboarding.

progressobjectrequired
subtasksArray of objectsrequired
tagsArray of objectsrequired
created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

_tagstringrequired
Value:"Task"
Response
{ "id": "task_abc123def456", "form_id": "tlin_abc123def456", "form_custom_attributes": { "property1": null, "property2": null }, "name": "string", "employee_id": "ee_abc123def456", "employer_id": "er_abc123def456", "client_id": "cl_abc123def456", "job_id": "job_abc123def456", "status": "requires_action", "pdf": { "status": "available", "file_id": "f_01k5vmjjhq2wzt8b6rnq4c9xye" }, "next_action": { "type": "employer_action" }, "expired_at": "string", "deletion_scheduled_at": "string", "deletion_allowed_at": "string", "due_at": "string", "completed_at": "string", "completed_out_of_band": true, "progress": { "percent": 0, "numerator": 0, "denominator": 0 }, "subtasks": [ { … } ], "tags": [ { … } ], "created_at": "string", "updated_at": "string", "_tag": "Task" }