API Reference
//
Create a new task
Security
form_session or user_session or component_session or component_token or api_token
Any of:
Any of:
Placement Identifier
string(PlacementId)
Any of:
a string to be decoded into a DateTime.Utc
string(DateTimeUtc)
Any of:
a string to be decoded into a DateTime.Utc
string(DateTimeUtc)
Any of:
a string to be decoded into a DateTime.Utc
string(DateTimeUtc)
- Mock serverhttps://docs.onboarded.com/_mock/openapi/api/v1/tasks
- Onboarded Production Serverhttps://app.onboarded.com/api/v1/tasks
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"
}'Task
Any of:
a string to be decoded into a DateTime.Utc
string(DateTimeUtc)
Any of:
a string to be decoded into a DateTime.Utc
string(DateTimeUtc)
Any of:
a string to be decoded into a DateTime.Utc
string(DateTimeUtc)
Any of:
a string to be decoded into a DateTime.Utc
string(DateTimeUtc)
Any of:
a string to be decoded into a DateTime.Utc
string(DateTimeUtc)
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.
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" }