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

# Get Benefit Coverage By Id

> Returns a Benefit Coverage object with the given id.



## OpenAPI

````yaml get /api/hris/v1/benefit-coverages/{id}
openapi: 3.1.0
info:
  title: Bindbee APIs
  version: 0.1.0
servers:
  - url: https://api.bindbee.dev
  - url: https://api-eu.bindbee.dev
security: []
paths:
  /api/hris/v1/benefit-coverages/{id}:
    get:
      tags:
        - Benefit Coverages
      summary: Get Benefit Coverage By Id
      description: Returns a Benefit Coverage object with the given id.
      operationId: get_benefit_coverage_by_id_api_hris_v1_benefit_coverages__id__get
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Id
        - name: include_raw_data
          in: query
          required: false
          schema:
            type: boolean
            description: >-
              Whether to include the original data Bindbee fetched from the
              third-party to produce these models.
            default: false
            title: Include Raw Data
          description: >-
            Whether to include the original data Bindbee fetched from the
            third-party to produce these models.
          example: false
        - name: include_custom_fields
          in: query
          required: false
          schema:
            type: boolean
            description: Whether to include custom fields in the response.
            default: false
            title: Include Custom Fields
          description: Whether to include custom fields in the response.
          example: false
        - name: expand
          in: query
          required: false
          schema:
            type: string
            description: >-
              Which relations should be returned in expanded form. Multiple
              relation names should be comma separated without spaces. You can
              also specify required fields in [] for each relation name.
            title: Expand
          description: >-
            Which relations should be returned in expanded form. Multiple
            relation names should be comma separated without spaces. You can
            also specify required fields in [] for each relation name.
          example: benefit,covered_dependents
        - name: x-connector-token
          in: header
          required: true
          schema:
            type: string
            title: X-Connector-Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HrisBenefitCoverage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    HrisBenefitCoverage:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          example: 018b18ef-c487-703c-afd9-0ca478ccd9d6
        remote_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Remote Id
          description: The third-party API ID of the matching object.
          example: '123321'
        modified_at:
          type: string
          title: Modified At
          description: This is the datetime that this object was last updated by Bindbee
          example: '2021-10-16T00:00:00Z'
        raw_data:
          anyOf:
            - type: object
            - type: 'null'
          title: Raw Data
          description: This is the Raw data
          example:
            key_1: Platform dependent data 1
            key_2: Platform dependent data 2
        custom_fields:
          anyOf:
            - type: object
            - type: 'null'
          title: Custom Fields
          description: The custom fields related to the model
          example:
            category_group: REG
            disability_type: ASBERG
            hire_date: '1991-03-16T00:00:00'
            hire_source: REFER
            nationality: USA
            original_hire_date: '1991-03-16T00:00:00'
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
          description: Currency of the coverage amount, such as USD, INR, or EUR.
          example: USD
        amount:
          anyOf:
            - type: number
            - type: 'null'
          title: Amount
          description: Coverage amount associated with the benefit.
          example: 500
        benefit:
          anyOf:
            - {}
            - type: 'null'
          title: Benefit
          description: The benefit enrollment this coverage amount is associated with.
          example: 018b18ef-c488-7d40-9131-91bbc47c1007
        covered_dependents:
          anyOf:
            - items: {}
              type: array
            - type: 'null'
          title: Covered Dependents
          description: The dependents covered under this benefit coverage record.
          example:
            - 018abccb-c4a9-72f6-be1d-3fc7aaf2be67
        is_employee_covered:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Employee Covered
          description: >-
            Indicates whether the employee is covered under this benefit
            coverage record.
          example: true
      type: object
      required:
        - id
        - remote_id
        - modified_at
        - custom_fields
        - currency
        - amount
        - benefit
        - covered_dependents
        - is_employee_covered
      title: HrisBenefitCoverage
      description: >-
        The Hris Benefit Coverage object represents the coverage amount
        associated with a benefit enrollment, identifying which employee and/or
        dependents that amount applies to.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````