Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Labels

Retrieve the labels for a customer

Provides the labels that have been set for the specified customer.

You need the "View customers" permission to use this endpoint.

get/v2/customers/{customer_identifier}/labels

Path parameters

customer_identifierstring uuid required

The unique identifier we provided when you created the customer.

Query parameters

page_numberinteger

One-based page index (1..N)

page_sizeinteger

The size of the page to be returned

Response

Label list

firststring required

The URL path to the first page.

nextstring nullable

The URL path to the next page.

prevstring nullable

The URL path to the previous page.

selfstring required

The URL path to the current page.

total_countinteger nullable

Total number of items.

Example response

{
  "first": "/v2/resource?page_number=1",
  "next": "/v2/resource?page_number=4",
  "prev": "/v2/resource?page_number=2",
  "self": "/v2/resource?page_number=3",
  "total_count": 60
}