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

# Get company benefit details

> Retrieve detailed information about a specific company benefit.
Provides comprehensive benefit details including plans, eligibility rules,
expense categories, pricing, and configuration information.




## OpenAPI

````yaml external-api-schema.yml get /v1/company-benefits/{company_benefit_id}
openapi: 3.0.3
info:
  title: Vitable External Partner API
  version: 1.0.0
  description: >
    External API for Payroll Providers and PEO platforms to integrate with
    Vitable health plan products 

    for benefit administration. This API enables partner systems to manage
    benefit enrollment, 

    employee data, and plan information for their clients.


    Common integration scenarios:

    - Retrieve active benefit plans for employers

    - List enrolled employees for benefit periods  

    - Create and update employee records

    - Manage benefit enrollments and elections

    - Access enrollment status and eligibility information
servers:
  - url: https://api.vitablehealth.com
    description: Production server
  - url: https://api-staging.vitablehealth.com
    description: Staging server
security:
  - partnerApiKey: []
tags:
  - name: Company Benefits
    description: Benefit plans available to companies (plan years)
  - name: Company Members
    description: Employee management and information
  - name: Benefit Enrollments
    description: Employee benefit enrollment status and management
  - name: Member Benefits
    description: Individual employee benefit information
  - name: Benefit Eligibility
    description: Employee benefit eligibility information
  - name: Payroll Integration
    description: Payroll deduction and contribution calculations
  - name: Quoting
    description: Marketplace plan searches and insurance quotes
paths:
  /v1/company-benefits/{company_benefit_id}:
    get:
      tags:
        - Company Benefits
      summary: Get company benefit details
      description: >
        Retrieve detailed information about a specific company benefit.

        Provides comprehensive benefit details including plans, eligibility
        rules,

        expense categories, pricing, and configuration information.
      operationId: get_company_benefit
      parameters:
        - in: path
          name: company_benefit_id
          schema:
            type: string
            format: uuid
          required: true
          description: Unique identifier for the company benefit
      responses:
        '200':
          description: Company benefit details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCompanyBenefitResponse'
      security:
        - partnerApiKey: []
components:
  schemas:
    GetCompanyBenefitResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CompanyBenefitDTO'
    CompanyBenefitDTO:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the benefit
        type:
          type: string
          enum:
            - EBA
            - VPC
            - VPC_CORE
            - MEC
            - MEC2
            - MEC_PLUS
            - MVP
            - MVP2
            - MVPSL
            - MVPSL2
            - VD
            - VV
            - ICHRA
            - ICHRA_PREMIUM_PLUS
          description: Benefit type code
        name:
          type: string
          description: Benefit display name
        internal_name:
          type: string
          description: Internal benefit name
        vitable_managed_in:
          type: boolean
          description: Whether benefit is managed by Vitable
        plans:
          type: array
          items:
            $ref: '#/components/schemas/CompanyBenefitPlanDTO'
          description: Available benefit plans
        eligibility_rules:
          type: array
          items:
            $ref: '#/components/schemas/EligibilityRule'
          description: Benefit eligibility rules
        open_enrollment_start:
          type: string
          format: date
          description: Open enrollment start date
        open_enrollment_end:
          type: string
          format: date
          nullable: true
          description: Open enrollment end date
        coverage_start:
          type: string
          format: date
          description: Coverage start date
        coverage_end:
          type: string
          format: date
          nullable: true
          description: Coverage end date
        carrier_id:
          type: string
          format: uuid
          description: Insurance carrier ID
        carrier:
          type: string
          enum:
            - Essential Benefit Administrators
            - Liferaft
            - Imagine360
            - Vitable
            - TrueClaim
          description: Insurance carrier name
        active_in:
          type: boolean
          description: Whether benefit is currently active
        configured_in:
          type: boolean
          description: Whether benefit is properly configured
        allowance_based_in:
          type: boolean
          description: Whether benefit uses allowance-based pricing
        health_wallet_enabled_in:
          type: boolean
          description: Whether health wallet is enabled
      required:
        - id
        - type
        - name
        - internal_name
        - vitable_managed_in
        - plans
        - eligibility_rules
        - open_enrollment_start
        - coverage_start
        - carrier_id
        - carrier
        - active_in
        - configured_in
        - allowance_based_in
        - health_wallet_enabled_in
    CompanyBenefitPlanDTO:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Plan identifier
        company_id:
          type: string
          format: uuid
          description: Company identifier
        name:
          type: string
          description: Plan name
        level:
          type: integer
          description: Plan level/tier
        employee_enrollment_count:
          type: integer
          nullable: true
          description: Number of employees enrolled
        dependent_enrollment_count:
          type: integer
          nullable: true
          description: Number of dependents enrolled
        tier_costs:
          type: array
          items:
            $ref: '#/components/schemas/CompanyBenefitPlanTierCostDTO'
          description: Cost information by tier
        min_tier_cost:
          type: integer
          description: Minimum tier cost in cents
        max_dependent_cost:
          type: integer
          description: Maximum dependent cost in cents
        vitable_only_in:
          type: boolean
          description: Whether plan is Vitable-only
      required:
        - id
        - company_id
        - name
        - level
        - tier_costs
        - min_tier_cost
        - max_dependent_cost
        - vitable_only_in
    EligibilityRule:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Rule identifier
        employment:
          type: string
          enum:
            - Unspecified
            - Full Time
            - Part Time
            - Temporary
            - Seasonal
          description: Employment type requirement
        compensation:
          type: string
          enum:
            - Unspecified
            - Salary
            - Hourly
          description: Compensation type requirement
        location:
          type: string
          enum:
            - Unspecified
            - State
          description: Location requirement type
        location_value:
          type: string
          nullable: true
          description: Location requirement value
        readable_expression_str:
          type: string
          description: Human-readable rule expression
      required:
        - id
        - readable_expression_str
    CompanyBenefitPlanTierCostDTO:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Tier cost identifier
        benefit_plan_tier_name:
          type: string
          description: Tier name
        cost:
          type: integer
          description: Employee cost in cents
        cost_per_dependent:
          type: integer
          description: Per-dependent cost in cents
        dependents_required_in:
          type: boolean
          description: Whether dependents are required
        spouse_required_in:
          type: boolean
          description: Whether spouse is required
      required:
        - id
        - benefit_plan_tier_name
        - cost
        - cost_per_dependent
        - dependents_required_in
        - spouse_required_in
  securitySchemes:
    partnerApiKey:
      type: apiKey
      in: header
      name: X-Partner-API-Key
      description: Partner API key for external integrations

````