> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getmeasure.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Find Entitlements

> Search entitlements with given parameters



## OpenAPI

````yaml https://api.getmeasure.com/api/v1/docs/api_spec.json post /companies/{company_id}/entitlements/find
openapi: 3.1.0
info:
  title: Measure API
  description: APIs to communicate with Measure
  version: 1.0.0
servers:
  - url: https://api.getmeasure.com/api/v1
security: []
paths:
  /companies/{company_id}/entitlements/find:
    post:
      tags:
        - Entitlements
      summary: Find Entitlements
      description: Search entitlements with given parameters
      operationId: Find_Entitlements
      parameters:
        - name: company_id
          in: path
          description: 'The company ID with the prefix ''cmp_''. '
          required: true
          schema:
            description: 'The company ID with the prefix ''cmp_''. '
            type: string
        - name: Idempotency-Key
          in: header
          description: >-
            The idempotency key that will be used to ensure the request is only
            performed once
          schema:
            description: >-
              The idempotency key that will be used to ensure the request is
              only performed once
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestFindEntitlementRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseFindEntitlementResponse'
      deprecated: false
      security:
        - apiKey:
            - ''
components:
  schemas:
    RequestFindEntitlementRequest:
      properties:
        include_meta:
          description: >-
            Whether to include additional metadata in the pagination response
            such the number of total results
          type:
            - boolean
            - 'null'
        pagination:
          $ref: '#/components/schemas/RequestPaginationRequest'
          description: The pagination parameters for the request
        query:
          $ref: '#/components/schemas/RequestFindEntitlementQueryCriteria'
          description: The query criteria for the request
        sort_key:
          default: createdAtDesc
          enum:
            - createdAtDesc
            - createdAtAsc
            - updatedAtAsc
            - updatedAtDesc
          type: string
      required:
        - pagination
      type: object
    ResponseFindEntitlementResponse:
      properties:
        pagination:
          $ref: '#/components/schemas/ResponsePaginationResponse'
        results:
          items:
            $ref: '#/components/schemas/ResponseEntitlementRepresentation'
          type:
            - array
            - 'null'
      type: object
    RequestPaginationRequest:
      description: The pagination parameters for the request
      properties:
        from_key:
          type:
            - 'null'
            - string
        limit:
          default: 20
          format: int64
          maximum: 200
          minimum: 0
          type: integer
      type: object
    RequestFindEntitlementQueryCriteria:
      properties:
        aggregator_type:
          description: The aggregator type of the entitlement
          type:
            - 'null'
            - string
        key:
          description: The key for the entitlement
          type:
            - 'null'
            - string
        name:
          description: The name of the entitlement
          type:
            - 'null'
            - string
        search:
          description: Any search string to match entitlements
          type:
            - 'null'
            - string
        type:
          description: The type of the entitlement
          type:
            - 'null'
            - string
      type: object
    ResponsePaginationResponse:
      properties:
        from_key:
          type:
            - 'null'
            - string
        limit:
          format: int64
          type: integer
      type: object
    ResponseEntitlementRepresentation:
      properties:
        aggregator_type:
          description: The aggregator type of the entitlement
          type: string
        id:
          description: The ID of the entitlement
          type: string
        key:
          description: The key of the entitlement
          type: string
        name:
          description: The name of the entitlement
          type: string
        possible_values:
          description: >-
            The possible values of the entitlement if the type is ENUM or
            MULTI_ENUM
          items:
            type: string
          type: array
        type:
          description: >-
            The type of the entitlement that can be BOOL, TEXT, NUMBER, ENUM, or
            MULTI_ENUM
          type: string
      type: object
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````