---
title: "List Labels"
method: GET
path: "/api/v1/labels"
tags: ["Labels"]
---

# List Labels

`GET /api/v1/labels`

Retrieves a paginated list of labels. Can be filtered by `name`.

## Query parameters

- `filter[name]` string
- `include` string
- `sort` string
- `page` integer
- `per_page` integer

## Response `200`

Successful response

- LabelsListResponse
  - `data` Labels[]
    - `id` integer — Unique identifier
    - `colour` 'blue' | 'blue_inverted' | 'cyan' | 'cyan_inverted' | 'gray' | 'gray_inverted' | 'green' | 'green_inverted' | 'orange' | 'orange_inverted' | 'pink' | 'pink_inverted' | 'purple' | 'purple_inverted' | 'red' | 'red_inverted' | 'yellow' | 'yellow_inverted'
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `name` string
  - `meta` PaginationMeta
    - `current_page` integer
    - `from` integer, nullable
    - `last_page` integer
    - `path` string
    - `per_page` integer
    - `to` integer, nullable
    - `total` integer
  - `links` PaginationLinks
    - `first` string, uri
    - `last` string, uri
    - `prev` string, uri, nullable
    - `next` string, uri, nullable

## Other responses

- `401` — Unauthenticated
- `403` — Unauthorized

---

[API](https://skmtc.net/wearepatchworks/apis/patchworks-core-api.md) · [All operations](https://skmtc.net/wearepatchworks/apis/patchworks-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wearepatchworks/patchworks-core-api/revisions/89261af4dd80/schema)