Retrieve a list of labels from a label group

Get labels from a specific label group based on the provided query criteria.

Note

The API returns a maximum of 500 labels per request. The default page size is 100.

The labels are sorted by the created_at date in reverse chronological order, and they're paginated. The page size, that is, the maximum number of labels returned per page is specified by the limit parameter.

• If the number of results exceeds the page size, the response also returns a cursor for the next page under next_page_token.
  To get the next page of results, make a new request using that next_page_token value in page_token.
• If the number of results is smaller than the page size, next_page_token is not returned.

For more details, see the guides: Manage accounting settings and Manage labels and label groups.

Request​

Path parameters

Path parameters

Example: "09ad1ad3-a1c0-4c09-b8f8-24b439e72690"

The ID of the label group from which to retrieve labels.

Query parameters

Query parameters

Possible values: >= 1 and <= 500
Example: 10

Default value: 100

The page size, that is, the maximum number of labels to return per page.

To get the next page of results, use page_token.

Example: "MjAyNi0wMS0wMVQwOToxMzoxNS40MDZaN2RhNTFjZGY0LTZiYjctNDRkNi04OWU1LTc2OWEzZGYxZDc5ZA"

Cursor for the next page. Used for pagination when the total number of results exceeds the maximum number per page.

To get the next page of results, make a new request and set page_token to the next_page_token value returned in the previous response.

Note

If there are no more results to fetch, next_page_token is not returned in the response.

Response​

List of labels

Response body

Body object

Example: "MjAyNi0wMS0wMVQwOToxMzoxNS40MDZaN2RhNTFjZGY0LTZiYjctNDRkNi04OWU1LTc2OWEzZGYxZDc5ZA"

Cursor for the next page. Used for pagination when the total number of results exceeds the maximum number per page.

To get the next page of results, make a new request and set page_token to the next_page_token value returned in the previous response.

Note

If there are no more results to fetch, next_page_token is not returned in the response.

List of labels in the specified group

The unique ID of the label.

Possible length: non-empty and <= 100 characters

The name of the label.

The date and time the label was created in ISO 8601 format.

The date and time the label was last updated in ISO 8601 format.