Skip to content

List tasks in a date range

Open .md

POST/v1/api/store/{team_slug}/work_pipeline/calendar

v1Operation ID v1_public_work_pipeline_calendar

Tasks whose start or due date falls in the range, or whose dates span it. Returns at most 1,200 Tasks, in the requested sort, then Task id order. This route ignores page and per_page and never returns pagination.

The range runs from the start of the day of start_date to the end of the day of end_date. Send both as ISO 8601 date-times in UTC (2026-11-01T00:00:00Z): the day boundaries are taken from the date as written. Only tasks of live jobs on sales orders are listed.

If a range may hold more than 1,200 tasks, split it into shorter ranges. You can narrow it with the same filters and sort as Filter tasks. A date filter's value is a whole number of days, counted from the moment of the request in UTC: eq N matches the whole UTC day N days from today (0 is today, -1 yesterday); gte N matches dates on or after now plus N days; lte N matches dates on or before now minus N days. So "due in the next 7 days" is due_date gte 0 and due_date lte -7, and "overdue" is due_date lte 0. This differs from the v2 filters (Filter invoices, the production control calendar), where lte and gte both count forward.

Permission

Any member of the team. No sales order permission is checked.

Business rules

  • start_date and end_date are required ISO 8601 dates.
  • A task is in the range when its start or due date falls in it, or it starts before and is due after it. Undated tasks never appear.

Path parameters

  • team_slugstringrequired

    Your team slug, shown as Team ID next to your API key in Profile.

    • Example your-team

Request body

application/json, required.

  • end_datestring (date-time)required

    The last day of the range (ISO 8601).

  • start_datestring (date-time)required

    The first day of the range (ISO 8601).

  • filtersarray of objects

    Conditions, all of which must match. Omit for no filter.

    • At least 1 item
    Fields of each item (3)
    • keystringrequired

      What to filter on. See the table in the description.

      • One of: "status_id", "status_type", "pipeline_id", "assigned_users", "assigned_to_me", "order_created_by", "is_rush", "start_date", "due_date", "start_date_is_set", "due_date_is_set", "status_last_change_date", "status_completion_date", "search"
    • operatorstringrequired

      How to compare. Each kind of key accepts only some operators.

      • One of: "eq", "neq", "gt", "gte", "lt", "lte", "in", "nin", "bt", "ct", "sw", "ew"
    • valuestring | number | boolean | arrayrequired

      What to compare with: text, a number of days, true or false, or an array of hash ids or options, by kind of key.

  • sortarray of objects

    Sort keys, applied in order, then by task id. Without sort the tasks come by task id.

    Fields of each item (2)
    • directionstringrequired
      • One of: "asc", "desc"
    • keystringrequired
      • One of: "status_id", "status_label", "pipeline_id", "job_id", "start_date", "due_date", "status_last_change_date", "status_completion_date", "job_item_count", "order_cust_due_date", "order_due_date", "order_ship_due_date", "order_ship_due_date_undated_last", "created_at_id"

Response

200Successful response.

  • dataarray of objectsrequired
    Fields of each item (24)
    • assigned_usersarray of objects

      Who is assigned.

      Fields of each item (3)
    • created_atstring (date-time)
    • due_datestring (date-time) | null

      Task due date. ISO 8601 with offset, or null.

    • idstring

      The task.

    • job_idstring

      The job.

    • job_is_rushboolean | integer | null
    • job_item_countnumber | null
    • job_namestring | null
    • The job number with its prefix.

    • job_status_idstring | null

      The job's current status.

    • namestring
    • notestring | null
    • order_idstring

      The order.

    • order_namestring | null
    • order_scoped_idstring | null

      The order number.

    • The task preset it comes from.

    • positioninteger

      Order among tasks; lower comes first. 0 when unset.

    • A summary of the job's order.

      Child fields (14)
    • start_datestring (date-time) | null

      Task start. ISO 8601 with offset, or null.

    • statusobject

      A status: label, kind and place in the list.

      Child fields (9)
      • colorstring | null

        Hex color.

      • idstring

        The status.

      • labelstring
      • Only on the statuses of a task preset (role pipeline): the task preset. Absent on other statuses.

      • positioninteger

        Its place in the team's list: sort by it to find the next status.

      • rolestring

        Which list it belongs to: job for job statuses, pipeline for the statuses of a task preset.

        • One of: "order", "quote", "job", "purchase_order", "shipment", "customer_message", "pipeline"
      • trashedboolean

        The status was deleted.

      • typestring

        The kind of status: start (Pending), pre_production and in_progress (In Progress), end (Completed).

        • One of: "start", "pre_production", "in_progress", "end"
    • status_completion_datestring (date-time) | null

      When it reached a Completed status. ISO 8601 with offset, or null.

    • status_idstring

      The task's status (a status of its task preset).

    • status_last_change_datestring (date-time) | null

      When the status last changed. ISO 8601 with offset, or null.

    • updated_atstring (date-time)
  • statusintegerrequired
  • successbooleanrequired

Errors

  • 401The API key is missing or wrong (unauthenticated).

  • 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  • 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

  • 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

    When
    A date is missing or not ISO 8601, or a filter is invalid.
    Fix
    Send both dates and valid filters.

Notes

  • You get the 1,200 tasks with the lowest ids (or first in your sort) in the range; nothing tells you more were left out.