Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Tasks > Task

Reads all Tasks

This endpoint retrieves all tasks created.

get/api/2026-07-01/resources/tasks/tasks

Query parameters

ids[]string[]

retrieve only the tasks that match the IDs passed in the request.

retrieve only the tasks that match the IDs passed in the request.

[
  "1",
  "2",
  "3"
]
company_idstring

retrieve the tasks that have a company_id associated

Example:1

retrieve the tasks that have a company_id associated

assignee_idstring

retrieve the tasks that have an assignee_id associated, assignee_id references to access_id.

Example:1

retrieve the tasks that have an assignee_id associated, assignee_id references to access_id.

due_onstring

filter by tasks that have a due date.

Example:2024-06-06

filter by tasks that have a due date.

already_dueboolean

filter by tasks that have expired or are still due.

Example:true

filter by tasks that have expired or are still due.

task_status'todo' | 'in_progress' | 'done' | 'discarded'

filter by tasks that with an especific status (todo | in_progress | done | discarded).

Example:todo

filter by tasks that with an especific status (todo | in_progress | done | discarded).

involvee_idstring

retrieve tasks where the user is affectee or assignee

Example:1

retrieve tasks where the user is affectee or assignee

category'benefits' | 'complaints' | 'compensation' | 'documents' | 'engagement' | 'finance' | 'organization' | 'performance' | 'policies' | 'recruitment' | 'software' | 'spending' | 'surveys' | 'timeoff' | 'time_planning' | 'time_tracking' | 'training'

filter by tasks that have a specific category

Example:benefits

filter by tasks that have a specific category

Response

OK

Example response

{
  "data": [
    {
      "id": "1",
      "name": "My task",
      "company_id": "1",
      "content": "Complete your performance review before Friday",
      "due_on": "2024-06-06",
      "assignee_ids": [
        "1"
      ],
      "author_employee_id": "1",
      "completed_at": "2024-01-01T00:00:00Z",
      "completed_by_id": "1",
      "created_at": "2024-01-20T18:05:45.000Z",
      "updated_at": "2024-01-20T18:05:45.000Z",
      "status": "todo"
    }
  ]
}