Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Labels

Get a list of labels

This endpoint allows you to retrieve all the labels in an account. It can also be used to perform a direct search on a label identifier or name, and can be sorted by name or created at of the labels.

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

get/v2/labels

Query parameters

namestring[]

The unique name you provided when you created the label.

identifierstring[]

The unique identifier we provided when you created the label.

searchstring
page_numberinteger

One-based page index (1..N)

page_sizeinteger

The size of the page to be returned

Response

Get a list of labels

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 required

Total number of labels.

Example response

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