Dec 2025 - New! Caching input tokens unlocks immediate, automatic ~30% credit savings on supported models
cURL
curl --request POST \ --url http://localhost:3000/api/user/refresh/entitlements \ --header 'x-access-token: <api-key>'
{ "success": true, "entitlements": [ { "_id": "<string>", "entitlements": [ "<string>" ], "accountType": "super", "status": "active", "creditAwarded": 123, "user": "<string>", "created": "2023-11-07T05:31:56Z", "lastLogin": "2023-11-07T05:31:56Z", "lastKA": "2023-11-07T05:31:56Z", "digitaltwin": true, "institution": "<string>", "institution_data": {}, "account_data": {} } ] }
Retrieves and refreshes the current user’s entitlements across all institutions and accounts they have access to
JWT token passed in x-access-token header
Successfully refreshed user entitlements
Indicates if the operation was successful
Array of user entitlement records with associated data
Show child attributes
Unique identifier for the entitlement record
Array of permission strings (e.g., "institutions.list", "users.add")
Type of account (super, admin, or user)
super
admin
user
Current status of the entitlement
active
inactive
pending
Number of credits awarded to the user
User ID associated with this entitlement
Creation timestamp
Last login timestamp
Last keep-alive timestamp
Whether digital twin is enabled
Institution ID (optional)
Detailed institution information (when available)
Detailed account information (when available)
Was this page helpful?