> ## 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 Employer Benefit By Id

> Returns a Employer Benefit object with the given id.



## OpenAPI

````yaml get /api/hris/v1/employer-benefits/{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/employer-benefits/{id}:
    get:
      tags:
        - Employer Benefits
      summary: Get Employer Benefit By Id
      description: Returns a Employer Benefit object with the given id.
      operationId: get_employer_benefit_by_id_api_hris_v1_employer_benefits__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.
            examples:
              - false
            default: false
            title: Include Raw Data
          description: >-
            Whether to include the original data Bindbee fetched from the
            third-party to produce these models.
        - name: include_custom_fields
          in: query
          required: false
          schema:
            type: boolean
            description: Whether to include custom fields in the response.
            examples:
              - false
            default: false
            title: Include Custom Fields
          description: Whether to include custom fields in the response.
        - 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/HrisEmployerBenefit'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    HrisEmployerBenefit:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          examples:
            - 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.
          examples:
            - '123321'
        modified_at:
          type: string
          title: Modified At
          description: This is the datetime that this object was last updated by Bindbee
          examples:
            - '2021-10-16T00:00:00Z'
        raw_data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Raw Data
          description: This is the Raw data
          examples:
            - key_1: Platform dependent data 1
              key_2: Platform dependent data 2
        custom_fields:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Custom Fields
          description: The custom fields related to the model
          examples:
            - 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'
        plan_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Plan Name
          description: The name of the plan.
          examples:
            - 401(k) Plan
        provider_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Provider Name
          description: The name of the benefit provider.
          examples:
            - Metlife
        benefit_plan_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Benefit Plan Type
          description: The type of benefit plan
          examples:
            - Health Insurance
        deduction_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Deduction Code
          description: The employer benefit's deduction code.
          examples:
            - KT
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: The employer benefit's description.
          examples:
            - KTO Silver Plan
        benefit_plan_category:
          anyOf:
            - type: string
            - type: 'null'
          enum:
            - MEDICAL
            - VISION
            - DENTAL
            - HEALTH_SAVINGS
            - FLEXIBLE_SPENDING
            - LIFE_INSURANCE
            - DISABILITY
            - SUPPLEMENTAL_INSURANCE
            - RETIREMENT
            - WELLNESS
            - OTHER
          title: Benefit Plan Category
          description: >-
            The category of the plan. If the value is not one of the defined
            enum values, the original value passed through will be returned.
          examples:
            - MEDICAL
        coverage_tiers:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          items:
            enum:
              - WAIVED
              - EMPLOYEE_ONLY
              - EMPLOYEE_SPOUSE
              - EMPLOYEE_CHILD
              - EMPLOYEE_CHILDREN
              - EMPLOYEE_FAMILY
              - EMPLOYEE_DOMESTIC_PARTNER
              - HSA_FAMILY
              - SPOUSE
              - EMPLOYEE_1_DEPENDENT
              - EMPLOYEE_1_HOUSEHOLD_MEMBER
          title: Coverage Tiers
          description: >-
            The coverage tiers for the benefit plan. If the value is not one of
            the defined enum values, the original value passed through will be
            returned.
          examples:
            - EMPLOYEE_SPOUSE
            - EMPLOYEE_CHILDREN
        start_date:
          anyOf:
            - type: string
            - type: 'null'
          title: Start Date
          description: The day and time the benefit started.
          examples:
            - '2023-10-18T00:00:00Z'
        end_date:
          anyOf:
            - type: string
            - type: 'null'
          title: End Date
          description: The day and time the benefit ended.
          examples:
            - '2024-10-16T00:00:00Z'
      type: object
      required:
        - id
        - remote_id
        - modified_at
        - custom_fields
        - plan_name
        - provider_name
        - benefit_plan_type
        - deduction_code
        - description
        - benefit_plan_category
        - coverage_tiers
        - start_date
        - end_date
      title: HrisEmployerBenefit
      description: >-
        The Employer Benefit object is used to represent a benefit plan offered
        by a company.
    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

````