List the task statuses of a task preset

GET/v1/api/store/{team_slug}/setting/status/pipeline/{hash_id}

v1Operation ID v1_public_status_list_pipeline

Returns the statuses of one task preset (role pipeline): the steps a task moves through. The path takes the task preset's id, from GET /v1/api/store/{team_slug}/setting/pipeline. Deleted statuses are left out.

The list is not sorted: sort by position (lowest first). A valid id that names no task preset answers an empty list, not 404.

Permission

Any member of the team, whatever their role. This is wider than the web app, whose Settings pages need Manage Settings: on the API only changes need it.

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 preset, from GET /v1/api/store/{team_slug}/setting/pipeline. Its hash id from an earlier answer; there is no unique key for it.

  • Example eIOQnV5PP0pp7c

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (9)

  • colorstringrequired
  • customer_labelstringrequired

    What customers see in the customer portal. When none is set: Pending for start, In Progress for in_progress and pre_production, Completed for end.

  • idstringrequired
  • labelstringrequired
  • positionintegerrequired

    Sort order within the list, lowest first.

  • rolestringrequired

    Which list the status belongs to:

    • order: sales orders
    • quote: quotes
    • job: jobs
    • purchase_order: purchase orders
    • shipment: shipments
    • customer_message: message threads
    • pipeline: tasks within a task preset
    • One of: "order", "quote", "job", "purchase_order", "shipment", "customer_message", "pipeline"
  • trashedbooleanrequired

    True for a deleted status. Only the full list includes deleted ones.

  • typestringrequired

    The stage of the status in the workflow: start (first status in the list), pre_production, in_progress, or end (final status).

    • One of: "start", "pre_production", "in_progress", "end"
  • pipeline_idstring

    The task preset, for pipeline statuses only. Absent for every other role.

• 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.

Notes

• Read the list once and reuse the ids; statuses change rarely.

Related

• GETList every status, including deleted ones/v1/api/store/{team_slug}/setting/status
• POSTCreate a status/v1/api/store/{team_slug}/setting/status

Example request

curl

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

Example response 200

Response

{
  "data": [
    {
      "color": "#f5f5f5",
      "customer_label": "Pending",
      "id": "fA3KDzwnMRc5Cd",
      "label": "To do",
      "pipeline_id": "eIOQnV5PP0pp7c",
      "position": 0,
      "role": "pipeline",
      "trashed": false,
      "type": "start"
    },
    {
      "color": "#424242",
      "customer_label": "Completed",
      "id": "MIJM9QpP6O0whd",
      "label": "Done",
      "pipeline_id": "eIOQnV5PP0pp7c",
      "position": 1,
      "role": "pipeline",
      "trashed": false,
      "type": "end"
    }
  ],
  "status": 200,
  "success": true
}