Returns the entitlements assigned to the authenticated principal with pagination, sorting, and filtering, optionally scoped to an application.
const url = 'https://example.com/api/v1/provision/consumer/me/entitlements?pageNumber=1&pageSize=100';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/api/v1/provision/consumer/me/entitlements?pageNumber=1&pageSize=100'Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Optional application scope filter.
1-based page number to return.
Maximum number of items per page.
Optional sort expression; ascending when omitted.
Optional filter expression applied to the results.
Responses
Section titled “Responses”Returns the list of entitlements assigned to the caller.
Serializable IPaginatedList<T> implementation used to deserialize paged API responses. int PaginatedListDto<T>.TotalPages, bool PaginatedListDto<T>.HasPreviousPage, and bool PaginatedListDto<T>.HasNextPage are computed from the other properties.
object
The 1-based index of this page within the full result set.
The maximum number of items per page that was requested.
The total number of items across all pages.
The items on this page.
An entitlement granted to the calling user.
object
Link to the license terms (EULA) the licence was issued under; null when there are none.
The holder’s own view of the subscription — Pending, Trialing, Active,
Paused, Expired, … as a stable name — never the vendor’s lifecycle status.
The key the licence was issued under, when the holder is meant to see one.
The products this entitlement licenses.
A product named on an entitlement, as the holder sees it.
object
The version of the product the licence covers; empty when the product has none.
The total number of pages, computed from int PaginatedListDto<T>.TotalCount and int PaginatedListDto<T>.PageSize; 0 when int PaginatedListDto<T>.PageSize is not positive.
Whether a page precedes this one (int PaginatedListDto<T>.PageNumber is greater than 1).
Whether a page follows this one (int PaginatedListDto<T>.PageNumber is less than int PaginatedListDto<T>.TotalPages).
Serializable IPaginatedList<T> implementation used to deserialize paged API responses. int PaginatedListDto<T>.TotalPages, bool PaginatedListDto<T>.HasPreviousPage, and bool PaginatedListDto<T>.HasNextPage are computed from the other properties.
object
The 1-based index of this page within the full result set.
The maximum number of items per page that was requested.
The total number of items across all pages.
The items on this page.
An entitlement granted to the calling user.
object
Link to the license terms (EULA) the licence was issued under; null when there are none.
The holder’s own view of the subscription — Pending, Trialing, Active,
Paused, Expired, … as a stable name — never the vendor’s lifecycle status.
The key the licence was issued under, when the holder is meant to see one.
The products this entitlement licenses.
A product named on an entitlement, as the holder sees it.
object
The version of the product the licence covers; empty when the product has none.
The total number of pages, computed from int PaginatedListDto<T>.TotalCount and int PaginatedListDto<T>.PageSize; 0 when int PaginatedListDto<T>.PageSize is not positive.
Whether a page precedes this one (int PaginatedListDto<T>.PageNumber is greater than 1).
Whether a page follows this one (int PaginatedListDto<T>.PageNumber is less than int PaginatedListDto<T>.TotalPages).
Examplegenerated
{ "pageNumber": 1, "pageSize": 1, "totalCount": 1, "items": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "version": "example", "description": "example", "licenseTermsUrl": "example", "planName": "example", "isTrial": true, "expirationDateTime": "2026-04-15T12:00:00Z", "subscriptionStatus": "example", "licenseKey": "example", "products": [ { "name": "example", "productCode": "example", "productVersion": "example" } ] } ], "totalPages": 1, "hasPreviousPage": true, "hasNextPage": true}Serializable IPaginatedList<T> implementation used to deserialize paged API responses. int PaginatedListDto<T>.TotalPages, bool PaginatedListDto<T>.HasPreviousPage, and bool PaginatedListDto<T>.HasNextPage are computed from the other properties.
object
The 1-based index of this page within the full result set.
The maximum number of items per page that was requested.
The total number of items across all pages.
The items on this page.
An entitlement granted to the calling user.
object
Link to the license terms (EULA) the licence was issued under; null when there are none.
The holder’s own view of the subscription — Pending, Trialing, Active,
Paused, Expired, … as a stable name — never the vendor’s lifecycle status.
The key the licence was issued under, when the holder is meant to see one.
The products this entitlement licenses.
A product named on an entitlement, as the holder sees it.
object
The version of the product the licence covers; empty when the product has none.
The total number of pages, computed from int PaginatedListDto<T>.TotalCount and int PaginatedListDto<T>.PageSize; 0 when int PaginatedListDto<T>.PageSize is not positive.
Whether a page precedes this one (int PaginatedListDto<T>.PageNumber is greater than 1).
Whether a page follows this one (int PaginatedListDto<T>.PageNumber is less than int PaginatedListDto<T>.TotalPages).
Examplegenerated
{ "pageNumber": 1, "pageSize": 1, "totalCount": 1, "items": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "version": "example", "description": "example", "licenseTermsUrl": "example", "planName": "example", "isTrial": true, "expirationDateTime": "2026-04-15T12:00:00Z", "subscriptionStatus": "example", "licenseKey": "example", "products": [ { "name": "example", "productCode": "example", "productVersion": "example" } ] } ], "totalPages": 1, "hasPreviousPage": true, "hasNextPage": true}If the user is not authenticated.
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}The caller lacks the user-session scope, or no user on the environment matches its sign-in (license.unknown_user).
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}The user directory could not be reached to look the signed-in user up (service.unavailable); retry with backoff.