Skip to content
/Tasks

List all tasks

Request

Security
form_session or user_session or component_session or component_token or api_token
Query
pagestring(page)

1-based page number. There is no upper bound; values below 1 are clamped to 1.

per_pagestring(between(1, 100))

a number between 1 and 100

form_idstring(FormId)

Form Identifier (lineage uid)

employee_idstring(EmployeeId)^ee_

Employee Identifier

employer_idstring(EmployerId)^er_

Employer Identifier

client_idstring(ClientId)^cl_

Client Identifier

job_idstring(JobId)^job_

Job Identifier

statusstring
Enum:"requires_action""completed""expired"
expired_at_ltestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

expired_at_gtestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

due_at_ltestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

due_at_gtestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

completed_at_ltestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

completed_at_gtestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

created_at_ltestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

created_at_gtestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

updated_at_ltestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

updated_at_gtestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/tasks?page=string&per_page=string&form_id=tlin_abc123def456&employee_id=ee_abc123def456&employer_id=er_abc123def456&client_id=cl_abc123def456&job_id=job_abc123def456&status=requires_action&expired_at_lte=string&expired_at_gte=string&due_at_lte=string&due_at_gte=string&completed_at_lte=string&completed_at_gte=string&created_at_lte=string&created_at_gte=string&updated_at_lte=string&updated_at_gte=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
dataArray of objects(Task)required
totalnumberrequired
current_pagenumberrequired
per_pagenumberrequired
total_pagesnumber
Response
{
  "data": [
    { … }
  ],
  "total": 0,
  "current_page": 0,
  "per_page": 0,
  "total_pages": 0
}