DIdistru
Task

Get tasks

Changed on

Lists the tasks belonging to the authenticated company, oldest-first (by creation time). Results never cross company boundaries and are paginated: next_page holds the URL of the following page, or null on the last page.

A task may be linked to exactly one other entity. The linked entity is returned as the matching relation field (order, invoice, purchase, contact, product, batch, assembly, return, or company); every other relation field is null. Tasks linked to an internal-only entity that has no public API model return every relation field as null. The relation field is also null when the authenticated user lacks the permission the linked entity's own list endpoint requires, or can't see it under their team restrictions.

Required permission: tasks_permissions_view. Only tasks the authenticated user can access under their team restrictions are returned.

get/public/v1/tasks

Request

  • Base URL
    https://app.distru.com
  • Auth
    HTTP bearer

Query parameters

idsstring[]

Restrict the result to specific tasks by ID. Repeat the bracketed key once per ID. Unknown IDs match nothing; an empty list is treated as no filter. At most 200 IDs.

owner_idsstring[]

Restrict to tasks owned by specific users, by user ID. Repeat the bracketed key once per ID. At most 200 IDs.

statusesstring[]

Filter to tasks with any of these statuses. Repeat the bracketed key once per status. At most 200.

related_typesstring[]

Filter to tasks linked to any of these entity kinds. Repeat the bracketed key once per kind. At most 200.

due_datetimestring

Filter by due datetime, a comma-separated start,end pair of ISO8601 datetimes (inclusive). Either bound may be omitted for an open-ended range.

inserted_datetimestring

Filter by creation datetime, a comma-separated start,end pair of ISO8601 datetimes (inclusive). Either bound may be omitted.

updated_datetimestring

Filter by last-updated datetime, a comma-separated start,end pair of ISO8601 datetimes (inclusive). Either bound may be omitted.

pagestring

Page selector. Page size is fixed by the server; paginate by following the next_page URL in each response rather than building page selectors yourself — it is null on the last page. next_page uses page[after]=<cursor>, an opaque token marking where the next page resumes; pass it back exactly as given, and only to the endpoint that issued it. This is seek-based, so every page stays fast no matter how deep you page.

Response

A list of tasks

next_pagestring

URL for the next page of results; null when there is no next page

Example response

{
  "data": [
    {
      "location": {
        "address": "1234 Warehouse Street, Oakland, CA",
        "company_id": "02c88a3f-d759-4973-88f9-60049d682524",
        "id": "02c88a3f-d759-4973-88f9-60049d682524",
        "license_id": "02c88a3f-d759-4973-88f9-60049d682524",
        "name": "Warehouse 1"
      }
    }
  ]
}

Changes

  • d5cbdfacb3c9Revision changes
    • info

      added the non-success response with the status

  • e8b3a3d07ad5Revision changes
    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status