---
title: "List tasks"
method: GET
path: "/api/v1/tasks"
tags: ["tasks"]
---

# List tasks

`GET /api/v1/tasks`

## Request

- Base URL: `https://demo.invoiceninja.com`
- URL: `https://demo.invoiceninja.com/api/v1/tasks`
- Auth: none declared. Required headers: `X-API-TOKEN`, `X-Requested-With`
- TypeScript: <https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/docs/api/v1/tasks/get.ts> (a function with typed inputs; its response is checked against the schema)

Lists tasks, search and filters allow fine grained lists to be generated.
     *
     *   Query parameters can be added to performed more fine grained filtering of the tasks, these are handled by the TaskFilters class which defines the methods available

## Query parameters

- `include` string
- `index` string
- `per_page` integer
- `page` integer
- `sort` string[]

## Headers

- `X-API-TOKEN` string, required
- `X-Requested-With` string, required

## Response `200`

A list of tasks

- object
  - `data` Task[]
    - `id` string: The hashed id of the task
    - `user_id` string: The hashed id of the user who created the task
    - `assigned_user_id` string: The assigned user of the task
    - `client_id` string: The hashed if of the client
    - `invoice_id` string: The hashed id of the invoice associated with the task
    - `project_id` string: The hashed id of the project associated with the task
    - `number` string: The number of the task
    - `time_log` string: An array of unix time stamps defining the start and end times of the task
    - `is_running` boolean: Determines if the task is still running
    - `is_deleted` boolean: Boolean flag determining if the task has been deleted
    - `task_status_id` string: The hashed id of the task status
    - `description` string: The task description
    - `duration` integer: The task duration in seconds
    - `task_status_order` integer: The order of the task
    - `rate` number: The task rate
    - `custom_value1` string: A custom value
    - `custom_value2` string: A custom value
    - `custom_value3` string: A custom value
    - `custom_value4` string: A custom value
    - `is_date_based` boolean: Boolean flag determining if the task is date based
    - `calculated_start_date` string: The calculated start date of the task
    - `invoice_documents` boolean: Boolean flags which determines whether to include the task documents on the invoice
    - `created_at` number: Timestamp
    - `updated_at` number: Timestamp
    - `archived_at` number: Timestamp
    - `hash` string: Unique hash identifier for this task
    - `meta` object: Metadata associated with this task
    - `status_id` string: The unique identifier of the task status
    - `status_order` integer: Sort order for status display
    - `status_sort_order` integer: Alternative sort order for status
    - `tags` TagAssignment[]: Tags assigned to the task
      - `id` string, required: The hashed tag id
      - `name` string, required: The tag name
      - `color` string, nullable: The tag color as a hex value, or null when unset
  - `meta` Meta
    - `pagination` Pagination
      - `total` integer: The total number of items
      - `count` integer: The number of items per page
      - `per_page` integer: The number of items per page
      - `current_page` integer: The current page number
      - `total_pages` integer: The total number of pages
      - `links` object: The pagination links

## Other responses

- `401`: Authentication error
- `403`: Authorization error
- `422`: Validation error
- `429`: Rate Limit Exceeded
- `5XX`: Server error
- `default`: Unexpected Error

## Changes

- **2026-05-31** `28befcbfadda`: 1 breaking
  - the response property `data/items/tags/items/color` became optional for the status `200`
- **2026-05-31** `edde330209e2`: 1 info
  - added the optional property `data/items/tags` to the response with the `200` status
- **2026-05-06** `89876e7e51d6`: 1 info
  - added the new optional `query` request parameter `sort`
- **2026-04-20** `69a36036d334`: 1 info
  - the response optional property `data/items/id` became read-only for the status `200`
- **2025-11-22** `00ad5cc89fad`: 5 info
  - added the optional property `data/items/hash` to the response with the `200` status
  - added the optional property `data/items/meta` to the response with the `200` status
  - added the optional property `data/items/status_id` to the response with the `200` status
  - added the optional property `data/items/status_order` to the response with the `200` status
  - …1 more

[Operation history](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/changes/api/v1/tasks/get.md)

---

[API](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference.md) - [All operations](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/revisions/bcda1f823746?raw)