Listing, Sorting and Filtering Entitlements
This endpoint returns the list of entitlements.
Sorting
The results from this endpoint can be ordered using the $orderby query parameter. Specify a field name, and optionally asc or desc.
Sorting is valid on the following fields: created, updated, createdBy, paymentMethodId, startDate, endDate, type
Filtering
There are two ways to filter the set of returned entitlements from this endpoint - the first is to use the $filter query parameter, the second is to use the
$label_key and $label query parameters.
$filter allows for entitlements to be filtered on the basis of fields in the schema using OData query syntax.
See this document for more details on the syntax used.
Filters are valid on the following fields: created, updated, createdBy, paymentMethodId, startDate, endDate, type, organizationName, organizationId
Examples:
?$top=10 - Returns only the first 10 entitlements from the list.
?$orderby=name desc - Sorts entitlements by name in descending order.
?$filter=name eq 'descriptive name' - Returns entitlements that match the provided name.
?$orderby=properties/created desc - Sorts entitlements by creation date in descending order.
?$filter=properties/created ge 2021-01-01T00:00:00Z - Returns entitlements created after January 1, 2021.