Sign in
Labels

List Labels

Retrieves a list of all the labels set up against the authenticated user's organisation.

get/customers/labels

Query parameters

archivedboolean

Whether to include archived resources in the response. When true, archived resources are returned; when false or omitted, only non-archived resources are returned.

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

The labels were successfully retrieved

Example response

{
  "data": [
    {
      "id": "000000-000000-000000-000000",
      "value": "VIP",
      "colour": "ff6634",
      "organisation_id": "000000-000000-000000-000000",
      "created_at": "2021-01-01T00:00:00.000Z",
      "updated_at": "2021-01-01T00:00:00.000Z"
    }
  ],
  "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