Show a task preset

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

v1Operation ID v1_public_pipeline_show

Returns one task preset, deleted or not, with its statuses.

Permission

Any team member can call it. Reading needs no extra permission.

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's id: a hash id from an earlier answer. Only hash ids work here; anything else answers 404 page_not_found.

  • Example SyqthLPEGyJQGY

Request body

This operation takes no request body.

Response

200Successful response.

• dataobjectrequired
  Child fields (7)

  • colorstringrequired

    A hex color.

  • enablebooleanrequired
  • idstringrequired
  • labelstringrequired
  • statusesarray of objectsrequired

    The preset's statuses, removed ones included (trashed: true). They are not sorted: order them by position.

    Fields of each item (9)

    • colorstringrequired
    • customer_labelstringrequired

      The name customers see. When none was set: Pending, In Progress or Completed, by type.

    • idstringrequired

      The status id, as task status changes take it.

    • labelstringrequired

      The status name people see.

    • pipeline_idstringrequired

      The task preset's id.

    • positionintegerrequired

      The order of the status in the preset, from 0.

    • rolestringrequired

      Always pipeline for task statuses.

    • trashedbooleanrequired

      True for a removed status. Removed statuses stay in the list.

    • typestringrequired

      start: where a new task begins. in_progress: working. end: the task is done.

      • One of: "start", "in_progress", "end"
  • trashedbooleanrequired

    True for a deleted task preset.

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

Related

• GETList the task statuses of a task preset/v1/api/store/{team_slug}/setting/status/pipeline/{hash_id}

Example request

curl

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

Example response 200

Response

{
  "data": {
    "color": "#1976d2",
    "enable": true,
    "id": "SyqthLPEGyJQGY",
    "label": "Screen printing",
    "statuses": [
      {
        "color": "#1976d2",
        "customer_label": "Pending",
        "id": "ta5ib44WIIqi1X",
        "label": "Pending",
        "pipeline_id": "SyqthLPEGyJQGY",
        "position": 0,
        "role": "pipeline",
        "trashed": false,
        "type": "start"
      },
      {
        "color": "#4caf50",
        "customer_label": "In Progress",
        "id": "v4teCIco0ZHebU",
        "label": "Started",
        "pipeline_id": "SyqthLPEGyJQGY",
        "position": 1,
        "role": "pipeline",
        "trashed": false,
        "type": "in_progress"
      },
      {
        "color": "#424242",
        "customer_label": "Completed",
        "id": "V4RV92MCWxFIjQ",
        "label": "Completed",
        "pipeline_id": "SyqthLPEGyJQGY",
        "position": 2,
        "role": "pipeline",
        "trashed": false,
        "type": "end"
      }
    ],
    "trashed": false,
    "version": 1
  },
  "status": 200,
  "success": true
}