# List task presets

```http
GET https://secure.yoprint.com/v1/api/store/{team_slug}/setting/pipeline
```

- API version: v1
- Operation ID: `v1_public_pipeline_index`
- Section: Team settings › [Task presets](https://developer.yoprint.com/reference/task-presets.md)
- Web page: https://developer.yoprint.com/reference/task-presets/v1-pipeline-index/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Returns all the team's task presets in one list, including deleted ones (`trashed: true`), each with its statuses.

Task presets (called pipelines in the API) are named sets of statuses that a task moves through, for example Pending, Started, Completed. The tasks on a job each follow a preset, and services can be linked to presets. Every answer includes the preset's `statuses`. Change them with the status operations: add, rename, reorder or remove them with Save a set of status changes.

## Permission

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

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Request body

This operation takes no request body.

### Example request

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

## Response

`200` Successful response.

Fields:

- `data` (array of objects, required)
  - Each item:
    - `color` (string, required): A hex color.
    - `enable` (boolean, required)
    - `id` (string, required)
    - `label` (string, required)
    - `statuses` (array of objects, required): The preset's statuses, removed ones included (`trashed: true`). They are not sorted: order them by `position`.
      - Each item:
        - `color` (string, required)
        - `customer_label` (string, required): The name customers see. When none was set: `Pending`, `In Progress` or `Completed`, by `type`.
        - `id` (string, required): The status id, as task status changes take it.
        - `label` (string, required): The status name people see.
        - `pipeline_id` (string, required): The task preset's id.
        - `position` (integer, required): The order of the status in the preset, from 0.
        - `role` (string, required): Always `pipeline` for task statuses.
        - `trashed` (boolean, required): True for a removed status. Removed statuses stay in the list.
        - `type` (string, required): `start`: where a new task begins. `in_progress`: working. `end`: the task is done. One of: `"start"`, `"in_progress"`, `"end"`.
    - `trashed` (boolean, required): True for a deleted task preset.
    - `version` (integer, required)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "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
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You 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`.
- `404` Not 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

- [List the task statuses of a task preset](https://developer.yoprint.com/reference/statuses/v1-status-list-pipeline.md): `GET /v1/api/store/{team_slug}/setting/status/pipeline/{hash_id}`
- [Create a task preset](https://developer.yoprint.com/reference/task-presets/v1-pipeline-store.md): `POST /v1/api/store/{team_slug}/setting/pipeline`
