# List tags

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

- API version: v1
- Operation ID: `v1_public_tag_index`
- Section: Products and catalog › [Tags](https://developer.yoprint.com/reference/tags.md)
- Web page: https://developer.yoprint.com/reference/tags/v1-tag-index/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Lists the team's tags, each with `id`, `name` and `color_hex`. The same tags are used on customers and on sales orders. The list is paged: `pagination` gives `total`, `count`, `perPage`, `currentPage` and `totalPages`. Ask for the next page with `page`; the page size is the team's setting (50 unless changed), and `per_page` is ignored.

## Permission

Any member of the team.

## Path parameters

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

## Query parameters

- `page` (integer, optional): The page to return. Pages hold the team's page size (`pagination_per_page` in team settings: 50 unless changed, 5 to 100). `per_page` is not read here. Default `1`. Minimum 1. Example `1`.

## Request body

This operation takes no request body.

### Example request

```bash
curl 'https://secure.yoprint.com/v1/api/store/your-team/tag' \
  -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_hex` (string | null, required): Such as `#2563EB`. Null for a tag saved without a color.
    - `id` (string, required)
    - `name` (string, required)
- `status` (integer, required)
- `success` (boolean, required)
- `pagination` (object, optional)
  - `count` (integer, required)
  - `currentPage` (integer, required)
  - `links` (object | array of any, required): Links to the neighbouring pages: `previous` and `next`, each present only when that page exists. An empty list, `[]`, when there is only one page.
    - `next` (string (uri), optional): The next page.
    - `previous` (string (uri), optional): The previous page.
  - `perPage` (integer, required)
  - `total` (integer, required)
  - `totalPages` (integer, required)

Example response:

```json
{
  "data": [
    {
      "color_hex": "#2563EB",
      "id": "zzVW0sylTIm6oo",
      "name": "Wholesale"
    }
  ],
  "pagination": {
    "count": 1,
    "currentPage": 1,
    "links": [],
    "perPage": 50,
    "total": 1,
    "totalPages": 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

- [Create a tag](https://developer.yoprint.com/reference/tags/v1-tag-store.md): `POST /v1/api/store/{team_slug}/tag`
- [Tag a customer](https://developer.yoprint.com/reference/customers/v1-customer-tag-attach.md): `PUT /v1/api/store/{team_slug}/customer/{hash_id}/tag/attach`
- [Tag an order](https://developer.yoprint.com/reference/sales-order-tags/v1-sales-order-tag-attach.md): `PUT /v1/api/store/{team_slug}/sales_order/{hash_id}/tag/attach`