Get a task

Open .md

GET/v2/api/store/{team_slug}/v2/work_pipeline/{hash_id}

v2Operation ID v2_public_job_work_pipeline_show

Returns one task: its job and order, preset, status, dates, position and assignees.

Permission

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

Path parameters

team_slugstringrequired
Your team slug, shown as Team ID next to your API key in Profile.
- Example your-team
hash_idstringrequired
The task's hash id. Hash ids only: a unique key or a document number gives 404.
- Example hpioY1gDBQZdbI

Request body

This operation takes no request body.

Response

200Successful response.

dataobjectrequired
A task.
Child fields (24)
- assigned_usersarray of objects
  Who is assigned.
  Fields of each item (3)
  - avatar_urlstring | null
  - idstring
    The user.
  - namestring
- 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)
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.
When
The task isn't your team's.
Fix
Check the task id.

PUTUpdate a task/v2/api/store/{team_slug}/v2/work_pipeline/{hash_id}
PUTChange a task's status/v2/api/store/{team_slug}/v2/work_pipeline/{hash_id}/status

Example request

curl

curl 'https://secure.yoprint.com/v2/api/store/your-team/v2/work_pipeline/hpioY1gDBQZdbI' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

{
  "data": {
    "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"
  },
  "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