List jobs in a date range

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

v1Operation ID v1_public_job_calendar

Jobs whose start or due date falls in the range, or whose dates span it. Send page (an integer from 1) and optionally per_page (blank means 500, otherwise an integer from 1 to 1000) to read the range page by page: the response is that page of the whole range, uncapped, with pagination. Without page, or with a blank one, the response holds at most 1,200 rows and no pagination, and per_page is ignored. Any other page or per_page value is a 422 that names the field. Rows follow the requested sort, then id, so pages never overlap or skip.

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.

Each job is the full job with its tasks (pipelines), mockup and production_file; services and pending_approval are left out. Only jobs on sales orders are listed: quotes, drafts and deleted jobs are left out.

You can narrow the range with the same filters and sort as Filter jobs. 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 job is in the range when its start date or its due date falls in it, or it starts before the range and is due after it. Undated jobs 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). The range ends at the end of this day.
start_datestring (date-time)required
The first day of the range (ISO 8601). The range starts at the start of this day.
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", "is_rush", "start_date", "due_date", "start_date_is_set", "due_date_is_set", "need_cust_provide_product", "job_has_pipelines", "has_any_pipelines", "status_last_change_date", "status_completion_date", "total_qty_need_ordering", "order_created_by", "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.
pageinteger
Read the range page by page. Without it, at most 1,200 jobs come back and no pagination.
- Minimum 1
per_pageinteger | null
Page size when page is sent. Ignored without page.
- Default 500
- Minimum 1
- Maximum 1000
sortarray of objects
Sort keys, applied in order, then by job id. Without sort the jobs come by job id.
Fields of each item (2)
- directionstringrequired
  - One of: "asc", "desc"
- keystringrequired
  - One of: "id", "due_date", "order_id", "status_id", "start_date", "impression_count", "item_count", "scoped_id", "is_rush", "position", "status_last_change_date", "status_completion_date", "order_due_date", "order_ship_due_date", "order_cust_due_date", "order_issue_date", "total_qty_need_ordering", "order_ship_due_date_undated_last", "created_at_id"

Response

200Successful response.

dataarray of objectsrequired
Fields of each item (41)
- approval_ready_mockup_design_countinteger
- assigned_usersarray of objects
  People on the job.
  Fields of each item (3)
  - avatar_urlstring | null
  - idstring
    The user.
  - namestring
- auto_saved_forstring | null
  Set only on autosave copies.
- customerobject
  Child fields (2)
  - idstring | null
    The customer.
  - namestring | null
- due_datestring (date-time) | null
  Production due date. ISO 8601 with offset, or null.
- from_legacyboolean
- has_serviceboolean
  Kept for older clients; not a count of services.
- idstring
  The job.
- impression_countnumber | null
- inventory_statusstring | null
  The stock status of the job's lines.
- is_rushboolean
- item_countnumber | null
  Units on the job.
- location_countnumber | null
- mockuparray of objects
  Mockup files.
  Fields of each item (3)
  - idstring
    The file.
  - namestring | null
  - urlstring | null
    Download link with its own access token.
- mockup_design_countinteger
- mockup_summaryobject
  Child fields (2)
  - countinteger
  - has_mockupsboolean
- namestring | null
- need_cust_provide_productboolean | integer | null
  Blanks are provided by the customer.
- notestring | null
- order_customer_po_numberstring | null
- order_idstring
  The order.
- order_scoped_idstring
  The order number.
- pdfarray of objects
  PDF links.
  Fields of each item (2)
  - labelstring
  - urlstring (uri)
    A download link that carries its own long-lived access token: don't publish it.
- pipelinesarray of objects
  The job's tasks.
  Fields of each item (24)
  - assigned_usersarray of objects
    Who is assigned.
    Same fields as data[].assigned_users.
  - 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
  - job_scoped_idstring
    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.
  - pipeline_idstring
    The task preset it comes from.
  - positioninteger
    Order among tasks; lower comes first. 0 when unset.
  - sales_orderobject
    A summary of the job's order.
    Child fields (14)
    created_bystring | null
    Who created the order.
    cust_due_datestring (date-time) | null
    Order customer due (in-hand) date. ISO 8601 with offset, or null.
    customer_idstring | null
    The customer.
    customer_namestring | null
    due_datestring (date-time) | null
    Order production due date. ISO 8601 with offset, or null.
    external_typestring | null
    shopify when the order came from Shopify, else null.
    is_quoteboolean
    issue_datestring (date-time) | null
    Order issue date. ISO 8601 with offset, or null.
    object_typestring | null
    sales_order or quote.
    ship_due_datestring (date-time) | null
    Order ship-by date. ISO 8601 with offset, or null.
    shopify_deleted_externallyboolean
    shopify_deleted_externally_atstring (date-time) | null
    When it was deleted in Shopify. ISO 8601 with offset, or null.
    start_datestring (date-time) | null
    Order production start. ISO 8601 with offset, or null.
    status_idstring | null
    The order status.
  - 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.
    customer_labelstring
    idstring
    The status.
    labelstring
    pipeline_idstring
    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)
- positioninteger | null
- pricing_original_totaldecimal pair
  The job's price before pricing rules, at the stored scale. A decimal pair: the amount is value ÷ 10^dp ({ "value": 1250, "dp": 2 } is 12.50). Read dp every time: it can differ between fields and records.
  - See Money and quantities.
- pricing_rule_appliedobject | null
  The pricing rule that set the job's decoration price, or null. These answers usually carry only type, the two ids and the two totals. List the jobs of a sales order or quote and Get one job of a sales order or quote answer with the full summary (the rule's current name and position, the prices before and after).
  Child fields (12)
  - afterstring | null
    Full summary only: the price after the rule, as a decimal string.
  - after_totaldecimal pair
    The decoration price after the rule. A decimal pair: the amount is value ÷ 10^dp ({ "value": 1250, "dp": 2 } is 12.50). Read dp every time: it can differ between fields and records.
    See Money and quantities.
  - basestring | null
    Full summary only: the decoration price the rule started from, as a decimal string.
  - base_typestring | null
    Full summary only: service_price.
  - normal_pricestring | null
    Full summary only: the price with no rule (the same as base for a job).
  - original_totaldecimal pair
    The decoration price before the rule. A decimal pair: the amount is value ÷ 10^dp ({ "value": 1250, "dp": 2 } is 12.50). Read dp every time: it can differ between fields and records.
    See Money and quantities.
  - pricing_group_idstring | null
    The pricing group.
  - pricing_group_namestring | null
    Full summary only: the group's name now.
  - pricing_group_removedboolean | null
    Full summary only: true when the group was removed since. The job keeps its price.
  - pricing_rule_idstring | null
    The pricing rule.
  - ruleobject | null
    Full summary only: the rule as the group holds it now (id, label, position, where 1 is the first rule checked), or null when it no longer exists.
  - typestring | null
    service on a job.
- pricing_totaldecimal pair
  The job's price, at the stored scale (usually 6 decimal places: { "value": 600000000, "dp": 6 } is 600.00). A decimal pair: the amount is value ÷ 10^dp ({ "value": 1250, "dp": 2 } is 12.50). Read dp every time: it can differ between fields and records.
  - See Money and quantities.
- production_filearray of objects
  Production files.
  - Same fields as data[].mockup.
- qr_code_urlstring | null
  A QR code image for the job.
- sales_orderobject
  A summary of the job's order.
  Child fields (14)
  - created_bystring | null
    Who created the order.
  - cust_due_datestring (date-time) | null
    Order customer due (in-hand) date. ISO 8601 with offset, or null.
  - due_datestring (date-time) | null
    Order production due date. ISO 8601 with offset, or null.
  - external_typestring | null
    shopify when the order came from Shopify, else null.
  - is_quoteboolean
  - is_rushboolean
  - issue_datestring (date-time) | null
    Order issue date. ISO 8601 with offset, or null.
  - namestring | null
    Order name.
  - object_typestring | null
    sales_order or quote.
  - ship_due_datestring (date-time) | null
    Order ship-by date. ISO 8601 with offset, or null.
  - shopify_deleted_externallyboolean
  - shopify_deleted_externally_atstring (date-time) | null
    When it was deleted in Shopify. ISO 8601 with offset, or null.
  - start_datestring (date-time) | null
    Order production start. ISO 8601 with offset, or null.
  - status_idstring | null
    The order status.
- scoped_idstring
  The job number as shown, with its JOB- prefix. Change a job number takes only the digits.
- services_still_validboolean
- start_datestring (date-time) | null
  Production start. ISO 8601 with offset, or null.
- statusobject
  A status: label, kind and place in the list.
  - Same fields as data[].pipelines[].status.
- status_completion_datestring (date-time) | null
  When it reached a Completed status. ISO 8601 with offset, or null.
- status_idstring
  The job's current status: its production stage. Look it up in List job statuses, or read status.
- status_last_change_datestring (date-time) | null
  When the status last changed. ISO 8601 with offset, or null.
- total_qty_need_orderingstring | null
  Quantity that still needs ordering, with 8 decimal places ("12.00000000"). A decimal string, such as "0.00000000"; parse it as a decimal.
- unique_keystring | null
  The job's unique key.
- versioninteger
statusintegerrequired
successbooleanrequired
paginationobject
Child fields (6)
- countintegerrequired
- currentPageintegerrequired
- linksobject | array of anyrequired
  Links to the neighbouring pages: previous and next, each present only when that page exists. An empty list, [], when there is only one page.
  Child fields (2)
  - nextstring (uri)
    The next page.
  - previousstring (uri)
    The previous page.
- perPageintegerrequired
- totalintegerrequired
- totalPagesintegerrequired

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; page is filled but not an integer from 1; per_page is outside 1 to 1000; or a filter is invalid.
Fix
Send ISO 8601 dates and valid paging and filters. The error names the field.

Notes

Without page you get the first 1,200 jobs of the range in the order you asked for (by id when you send no sort). A busy range can hold more: send page and read until pagination.currentPage equals pagination.totalPages.

POSTFilter jobs/v1/api/store/{team_slug}/job/filter
POSTList tasks in a date range/v1/api/store/{team_slug}/work_pipeline/calendar
POSTRead the production control calendar/v1/api/store/{team_slug}/production_control/filter

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/job/calendar' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "end_date": "2026-11-30T00:00:00Z",    "filters": [      {        "key": "status_type",        "operator": "nin",        "value": [          "end"        ]      }    ],    "page": 1,    "per_page": 500,    "start_date": "2026-11-01T00:00:00Z"  }'

Example response 200

{
  "data": [
    {
      "assigned_users": [],
      "auto_saved_for": null,
      "customer": {
        "id": "ifAHmADekGZ6id",
        "name": "Northwind Apparel"
      },
      "due_date": "2026-11-06T17:00:00+00:00",
      "id": "WaGvtaWsx7Kcn4",
      "is_rush": true,
      "item_count": 48,
      "mockup": [],
      "name": "Front print",
      "note": null,
      "order_id": "sFbALVSYD55eXe",
      "order_scoped_id": "SO1001",
      "pdf": [
        {
          "description": "Job details without mockup",
          "label": "Job Details",
          "url": "https://example.com/pdf/job-details.pdf"
        }
      ],
      "pipelines": [
        {
          "assigned_users": [
            {
              "avatar_url": null,
              "id": "4mdDkMg3dgQOa3",
              "name": "Alex Rivera"
            }
          ],
          "created_at": "2026-11-03T15:00:00+00:00",
          "due_date": "2026-11-05T17:00:00+00:00",
          "id": "hpioY1gDBQZdbI",
          "job_id": "WaGvtaWsx7Kcn4",
          "job_is_rush": 1,
          "job_item_count": 48,
          "job_name": "Front print",
          "job_scoped_id": "JOB-2419",
          "job_status_id": "scaWHQnPLtqMPT",
          "name": "Burn screens",
          "note": null,
          "order_id": "sFbALVSYD55eXe",
          "order_name": "Team shirts",
          "order_scoped_id": "SO1001",
          "pipeline_id": "SE3SfXjt6dPfnH",
          "position": 1,
          "sales_order": {
            "customer_id": "ifAHmADekGZ6id",
            "customer_name": "Northwind Apparel",
            "is_quote": false,
            "object_type": "sales_order",
            "status_id": "wgbOT87gGZvhgy"
          },
          "start_date": "2026-11-04T09:00:00+00:00",
          "status": {
            "color": "#2196f3",
            "customer_label": "In Progress",
            "id": "hTFITko5Q0R83y",
            "label": "Burning",
            "pipeline_id": "SE3SfXjt6dPfnH",
            "position": 2,
            "role": "pipeline",
            "trashed": false,
            "type": "in_progress"
          },
          "status_completion_date": null,
          "status_id": "hTFITko5Q0R83y",
          "status_last_change_date": "2026-11-03T15:05:00+00:00",
          "updated_at": "2026-11-03T15:05:00+00:00"
        }
      ],
      "position": 1,
      "pricing_original_total": {
        "dp": 6,
        "value": 600000000
      },
      "pricing_rule_applied": null,
      "pricing_total": {
        "dp": 6,
        "value": 600000000
      },
      "production_file": [],
      "sales_order": {
        "is_quote": false,
        "is_rush": false,
        "name": "Team shirts",
        "object_type": "sales_order",
        "status_id": "wgbOT87gGZvhgy"
      },
      "scoped_id": "JOB-2419",
      "start_date": "2026-11-04T09:00:00+00:00",
      "status": {
        "color": "#2196f3",
        "customer_label": "In Progress",
        "id": "scaWHQnPLtqMPT",
        "label": "Printing",
        "position": 3,
        "role": "job",
        "trashed": false,
        "type": "in_progress"
      },
      "status_completion_date": null,
      "status_id": "scaWHQnPLtqMPT",
      "status_last_change_date": "2026-11-03T15:05:00+00:00",
      "total_qty_need_ordering": "0.00000000",
      "unique_key": "job_EXAMPLEuniqueKey"
    }
  ],
  "pagination": {
    "count": 1,
    "currentPage": 1,
    "links": [],
    "perPage": 500,
    "total": 1,
    "totalPages": 1
  },
  "status": 200,
  "success": true
}

AI agents: read /llms.txt; add .md to any page URL for its Markdown. Guides and concepts in one file: /llms-full.txt.

Download the OpenAPI spec Support: support@yoprint.com yoprint.com