Fetch Entitlements

1 min

GET

https://api.nue.io/entitlements

Retrieve entitlement information for customers or by specific entitlement number. Entitlements represent what products and features customers are entitled to use, including usage limits and access controls.

customerIdsstringA JSON-encoded array of customer IDs to fetch entitlements for. Cannot be used with entitlementNumber.

entitlementNumberstringSpecific entitlement number to retrieve. Cannot be used with customerIds.

historybooleanWhether to include historical versions of the entitlement. Only works with entitlementNumber.

includesstringComma-separated list of additional data to include. Options: product, pricetags

statusstringFilter entitlements by status

acceptstringGenerated from available response content types

200Successfully retrieved entitlements

207Partial Success - Some customer IDs found, others not found

400Bad Request - The request was malformed or contained invalid parameters

401Unauthorized - Authentication information is missing or invalid

404Not Found - The requested resource was not found

curl --request GET \
     --url https://api.nue.io/entitlements \
     --header 'accept: application/json'