listEntitlements
listEntitlementsRetrieve paginated entitlements with filters by ID, name, type, product, and active status. Manage permissions and access efficiently.
Instructions
List entitlements in paginated form, with filtering by ID, name, type, product, and active status.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | The cursor for pagination. | |
| limit | No | Maximum number of records to return per page (defaults to 50). | |
| order | No | Order of results (e.g., '-created_at'). | -created_at |
| sort_key | No | Key to sort the results by. | created_at |
| sort_type | No | Sort order type ('ASC' or 'DESC'). | DESC |
| search | No | Text search across entitlement fields. | |
| id | No | Filter by entitlement ID. | |
| name__ilike | No | Case-insensitive partial match for entitlement name. | |
| entitlement_type | No | Filter by entitlement type. | |
| is_active | No | Filter by active status. | |
| product_id | No | Filter by associated product ID. | |
| __userContext | No | Internal user context for multi-tenant authentication and approval workflow |