v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13178889.9 KB
labels

List labels. For more information, see Search for labels.

get/v2/labels

Query parameters

customerstring

The customer to scope this list request to. For example: customers/abcd1234. If unset, will return all labels within the current customer.

languageCodestring

The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language are used.

minimumRole'LABEL_ROLE_UNSPECIFIED' | 'READER' | 'APPLIER' | 'ORGANIZER' | 'EDITOR'

Specifies the level of access the user must have on the returned labels. The minimum role a user must have on a label. Defaults to READER.

pageSizeinteger

Maximum number of labels to return per page. Default: 50. Max: 200.

pageTokenstring

The token of the page to return.

publishedOnlyboolean

Whether to include only published labels in the results. * When true, only the current published label revisions are returned. Disabled labels are included. Returned label resource names reference the published revision (labels/{id}/{revision_id}). * When false, the current label revisions are returned, which might not be published. Returned label resource names don't reference a specific revision (labels/{id}).

useAdminAccessboolean

Set to true in order to use the user's admin credentials. This will return all labels within the customer.

view'LABEL_VIEW_BASIC' | 'LABEL_VIEW_FULL'

When specified, only certain fields belonging to the indicated view are returned.

Response

Successful response