Retrieve a list of label groups

Get available label groups based on the provided query criteria.

The label groups are sorted by the created_at date in reverse chronological order, and they're paginated.

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

Request​

Query parameters

Query parameters

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

Default value: 100

The page size, that is, the maximum number of label groups 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 label groups

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 label groups.

The unique ID of the label group.

Possible length: non-empty and <= 100 characters

The name of the label group.

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

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