Skip to main content
GET
List entitlements
Retrieve entitlements under a customer. Use a customer ID in the path to scope results to one customer, or the wildcard distributor-customers/- to list across all of your customers. This endpoint supports pagination and filtering. For example, filter on status with status == 'active'. Learn more about entitlement statuses and the possible values.

Authorizations

Authorization
string
header
required

Bearer token authentication. When a distributor is registered, they receive an opaque bearer token (prefixed op_b_). Include it in the Authorization header of every request as Bearer <token>.

Path Parameters

distributor-customer
string
required

The customer ID to list entitlements for. Use the - wildcard to list across all of the distributor's customers. Each returned entitlement includes its own customer ID.

Query Parameters

max_page_size
integer<int32>

The maximum number of entitlements to return per page. Defaults to 100 when omitted or set to 0. Values greater than 100 are clamped to 100. Negative values return an invalid_argument error.

Required range: x >= 0
page_token
string

The pagination token that identifies the page of results to return. Tokens don't expire and must be treated as opaque.

filter
string

An optional filter in CEL syntax (for example, status == 'active'). When omitted, entitlements of all statuses are returned.

Response

A paginated list of the customer's entitlements.

The paginated list of entitlements.

results
object[]

The list of entitlements under the customer, or under all customers when using the - wildcard.

next_page_token
string

The token to use for the next page of results. Empty if there are no more results.