> ## 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 Benefits > Returns a list of Employer Benefit objects. ## OpenAPI ````yaml get /api/hris/v1/employer-benefits 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: get: tags: - Employer Benefits summary: Get Employer Benefits description: Returns a list of Employer Benefit objects. operationId: get_employer_benefits_api_hris_v1_employer_benefits_get parameters: - name: ids in: query required: false schema: anyOf: - type: string - type: 'null' description: The ID of the employer benefits to fetch examples: - >- 01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a title: Ids description: The ID of the employer benefits to fetch - name: benefit_plan_category in: query required: false schema: type: string description: >- The category of the benefit plan to filter by (e.g., MEDICAL, VISION, DENTAL, RETIREMENT, etc.) examples: - MEDICAL title: Benefit Plan Category description: >- The category of the benefit plan to filter by (e.g., MEDICAL, VISION, DENTAL, RETIREMENT, etc.) - name: remote_id in: query required: false schema: type: string description: The third-party API ID of the matching object. examples: - '3235005483341316245' title: Remote Id description: The third-party API ID of the matching object. - 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: modified_after in: query required: false schema: type: string description: >- If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601) examples: - '2024-02-21T21:22:12.993Z' title: Modified After description: >- If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601) - name: page_size in: query required: false schema: type: integer maximum: 200 minimum: 1 description: Number of results to return per page. Maximum size is 200. default: 50 title: Page Size description: Number of results to return per page. Maximum size is 200. - name: cursor in: query required: false schema: type: string description: The pagination cursor value. title: Cursor description: The pagination cursor value. - 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/PaginatedResponse_HrisEmployerBenefit_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] components: schemas: PaginatedResponse_HrisEmployerBenefit_: properties: cursor: anyOf: - type: string - type: 'null' title: Cursor description: Cursor value to fetch next set of items examples: - MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1 page_size: type: integer title: Page Size description: Indicates the count of items in the response examples: - 50 items: items: $ref: '#/components/schemas/HrisEmployerBenefit' type: array title: Items description: List of items in the current response examples: - {} type: object required: - cursor - page_size - items title: PaginatedResponse[HrisEmployerBenefit] HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError 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. 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 ````