Get a task by ID

Skip to content

API Reference

/

/

Get a task by ID

Get a task by ID

Request

Security

form_session or user_session or component_session or component_token or api_token

Path

task_idstring(TaskId)^task_required

Task Identifier

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

Responses

Task

Bodyapplication/json

idstring(TaskId)^task_required

Task Identifier

form_idstring(FormId)required

Form Identifier (lineage uid)

form_custom_attributesobjectrequired

namestringrequired

The name of the form

employee_idstring(EmployeeId)^ee_required

Employee Identifier

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)

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"
  },
  "next_action": {
    "type": "employer_action"
  },
  "expired_at": "string",
  "deletion_scheduled_at": "string",
  "deletion_allowed_at": "string",
  "due_at": "string",
  "completed_at": "string",
  "progress": {
    "percent": 0,
    "numerator": 0,
    "denominator": 0
  },
  "subtasks": [
    { … }
  ],
  "tags": [
    { … }
  ],
  "created_at": "string",
  "updated_at": "string",
  "_tag": "Task"
}