> ## Documentation Index > Fetch the complete documentation index at: https://docs2.zenskar.com/llms.txt > Use this file to discover all available pages before exploring further. # List entitlements > List entitlement given a `next` or `previous` cursor and a limit. If cursor is not provided you will get the beginning of the search set ## OpenAPI ````yaml /openAPI/openapi-20240301.json get /entitlements openapi: 3.1.0 info: title: zenskar version: 2.0.0 servers: - url: https://api.zenskar.com security: - ApiTokenAuth: [] OrganisationAuth: [] paths: /entitlements: get: tags: - Entitlements summary: List entitlements description: >- List entitlement given a `next` or `previous` cursor and a limit. If cursor is not provided you will get the beginning of the search set operationId: List-entitlements parameters: - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: >- The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response examples: - V2VsbCBhcmV1IGN1cmlvdxM= title: Cursor description: >- The cursor indicating a unique set of results - this should be auto generated and you get it from the `next` and `previous` fields of the response - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: The number of results to return - defaults to 10 examples: - 10 title: Limit description: The number of results to return - defaults to 10 - name: order in: query required: false schema: anyOf: - type: string - type: 'null' examples: - order=created_at default: '-created_at' title: Order - name: sort_key in: query required: false schema: anyOf: - type: string - type: 'null' examples: - sort_key=id title: Sort Key - name: sort_type in: query required: false schema: anyOf: - type: string - type: 'null' examples: - sort_key=asc title: Sort Type - name: search in: query required: false schema: anyOf: - type: string - type: 'null' title: Search - name: id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' title: Id - name: id__in in: query required: false schema: anyOf: - type: string - type: 'null' title: Id In - name: id__isnull in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Id Isnull - name: name in: query required: false schema: anyOf: - type: string - type: 'null' title: Name - name: name__ilike in: query required: false schema: anyOf: - type: string - type: 'null' title: Name Ilike - name: name__like in: query required: false schema: anyOf: - type: string - type: 'null' title: Name Like - name: name__in in: query required: false schema: anyOf: - type: string - type: 'null' title: Name In - name: name__isnull in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Name Isnull - name: description in: query required: false schema: anyOf: - type: string - type: 'null' title: Description - name: description__ilike in: query required: false schema: anyOf: - type: string - type: 'null' title: Description Ilike - name: description__like in: query required: false schema: anyOf: - type: string - type: 'null' title: Description Like - name: description__in in: query required: false schema: anyOf: - type: string - type: 'null' title: Description In - name: description__isnull in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Description Isnull - name: entitlement_type in: query required: false schema: anyOf: - type: string - type: 'null' title: Entitlement Type - name: entitlement_type__ilike in: query required: false schema: anyOf: - type: string - type: 'null' title: Entitlement Type Ilike - name: entitlement_type__like in: query required: false schema: anyOf: - type: string - type: 'null' title: Entitlement Type Like - name: entitlement_type__in in: query required: false schema: anyOf: - type: string - type: 'null' title: Entitlement Type In - name: entitlement_type__isnull in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Entitlement Type Isnull - name: units in: query required: false schema: anyOf: - type: string - type: 'null' title: Units - name: units__ilike in: query required: false schema: anyOf: - type: string - type: 'null' title: Units Ilike - name: units__like in: query required: false schema: anyOf: - type: string - type: 'null' title: Units Like - name: units__in in: query required: false schema: anyOf: - type: string - type: 'null' title: Units In - name: units__isnull in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Units Isnull - name: is_active__isnull in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Is Active Isnull - name: is_active in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Is Active - name: created_at in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Created At - name: created_at__neq in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Created At Neq - name: created_at__gt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Created At Gt - name: created_at__gte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Created At Gte - name: created_at__lt in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Created At Lt - name: created_at__lte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' title: Created At Lte - name: created_at__isnull in: query required: false schema: anyOf: - type: boolean - type: 'null' title: Created At Isnull - name: created_at__in in: query required: false schema: anyOf: - type: string - type: 'null' title: Created At In - name: apiversion in: header required: false schema: anyOf: - type: integer - type: 'null' title: Apiversion responses: '200': description: Successful Response content: application/json: schema: $ref: >- #/components/schemas/PaginatedResults_EntitlementResponseSchema_ '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: PaginatedResults_EntitlementResponseSchema_: properties: next: anyOf: - type: string - type: 'null' title: Next description: The cursor for the next page of results examples: - V2VsbCBhcmV1IGN1cmlvdxM= previous: anyOf: - type: string - type: 'null' title: Previous description: The cursor for the previous page of results examples: - GmBsbCBhcmV1IGN1cmlvdxM= total_count: anyOf: - type: integer - type: 'null' title: Total Count description: The total count of rows results: items: $ref: '#/components/schemas/EntitlementResponseSchema' type: array title: Results description: The results for the current page type: object required: - results title: PaginatedResults[EntitlementResponseSchema] HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError EntitlementResponseSchema: properties: id: type: string format: uuid title: Id description: Entitlement Id name: type: string title: Name description: Entitlement name description: anyOf: - type: string - type: 'null' title: Description description: Entitlement Description entitlement_type: anyOf: - $ref: '#/components/schemas/EntitlementType' - type: 'null' description: Entitlement Type units: anyOf: - type: string - type: 'null' title: Units description: Entitlement Units is_active: anyOf: - type: boolean - type: 'null' title: Is Active description: Entitlement is active default: true product_id: anyOf: - type: string format: uuid - type: 'null' title: Product Id description: Product ID created_at: anyOf: - type: string format: date-time - type: 'null' title: Created At description: created time type: object required: - id - name title: EntitlementResponseSchema description: Create Entitlement Response Schema ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError EntitlementType: type: string enum: - Feature - Quantity - Credits title: EntitlementType securitySchemes: ApiTokenAuth: type: apiKey in: header name: x-api-key x-default: OrganisationAuth: type: apiKey in: header name: organisation x-default: ````