List 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
Identifier of the organisation. Organisations group sites together under a single billing/admin entity; the caller's API key must have access to the named organisation.
Query parameters
Optional filter restricting the response to labels visible at the given site. When set, the response includes both labels with no site restriction (visible everywhere in the organisation) and labels explicitly scoped to this site via the label's site_ids list. When omitted, every label in the organisation is returned.
The page to retrieve results from
The number of results to return per page
Response
The labels were successfully retrieved.
Example response
{
"data": [
{
"id": "6630f7a8e1a4c2b1d4d5e7c1",
"name": "VIP",
"color": "#ff5733",
"organisation_id": "65a0c2e5b3a7d2f8c1d4e7b9",
"site_ids": [
"65a0c2e5b3a7d2f8c1d4e7ba",
"65a0c2e5b3a7d2f8c1d4e7bb"
]
}
],
"meta": {
"from": 1,
"to": 2,
"total": 2,
"current_page": 1,
"last_page": 2,
"per_page": 15,
"path": "http://example.com/api"
},
"links": {
"first": "http://example.com?page=1",
"next": "https://example.com?page=3",
"prev": "https://example.com?page=1",
"last": "https://example.com?page=4"
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.