---
title: "List Labels"
method: GET
path: "/shop/organisations/{organisationId}/labels"
tags: ["Organisations"]
---

# List Labels

`GET /shop/organisations/{organisationId}/labels`

Returns a paginated list of every label that belongs to the
organisation. Labels are coloured tags used to highlight or
categorise records (customers, bookings, orders) in the admin UI.
Use the pagination parameters to walk through large result sets.

## Path parameters

- `organisationId` string, uuid, required

## Query parameters

- `site_id` string, uuid
- `page` integer
- `per_page` integer

## Response `200`

The labels were successfully retrieved.

- object
  - `data` OrganisationLabel[], required
    - `id` string, uuid, required — The unique identifier of the label.
    - `name` string, required — Display name of the label, shown next to the records it is attached to in the admin UI. 1-40 characters; must not contain HTML.
    - `color` string, required — Hex colour used to render the label in the admin UI, including the leading `#`. Lower-case hexadecimal; must match `#rrggbb`. When unset on create, defaults to `#f1f1f1`.
    - `organisation_id` string, uuid, required — Identifier of the organisation that owns the label. Every label is scoped to exactly one organisation.
    - `site_ids` string[], required — Identifiers of the sites within the organisation that can see and apply this label. Empty array means the label is visible to every site under the organisation.
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set

## Other responses

- `401` — The user is unauthenticated
- `403` — The authenticated user does not have permission.
- `404` — The resource couldn't be found

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)