> ## 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.

# List employees for a company

> Retrieve a list of employees (company members) with filtering options.
This endpoint is essential for payroll providers to get employee rosters
and understand benefit eligibility.




## OpenAPI

````yaml external-api-schema.yml get /v1/company-members
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-members:
    get:
      tags:
        - Company Members
      summary: List employees for a company
      description: |
        Retrieve a list of employees (company members) with filtering options.
        This endpoint is essential for payroll providers to get employee rosters
        and understand benefit eligibility.
      operationId: list_company_members
      parameters:
        - in: query
          name: company_id
          schema:
            type: string
            format: uuid
          required: true
          description: Filter by company ID
        - in: query
          name: active_in
          schema:
            type: boolean
          description: Filter for active employees only
        - in: query
          name: benefits_eligible_in
          schema:
            type: boolean
          description: Filter for benefit-eligible employees only
        - in: query
          name: employee_class
          schema:
            type: string
            enum:
              - Full Time
              - Part Time
              - Temporary
              - Intern
              - Seasonal
              - Individual Contractor
          description: Filter by employment classification
        - in: query
          name: limit
          schema:
            type: integer
            default: 20
          description: Number of results to return per page
        - in: query
          name: page
          schema:
            type: integer
            default: 1
          description: Page number for pagination
      responses:
        '200':
          description: List of company members
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCompanyMembersResponse'
      security:
        - partnerApiKey: []
components:
  schemas:
    ListCompanyMembersResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CompanyMember'
        pagination:
          $ref: '#/components/schemas/PaginationInfo'
    CompanyMember:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the company member
        hris_id:
          type: string
          nullable: true
          description: External HRIS identifier
        type:
          type: string
          enum:
            - Employee
            - Recruit
            - Youth
          description: Type of company member
        active_in:
          type: boolean
          description: Indicates whether this company member is active
        company_active_in:
          type: boolean
          description: Indicates whether the company is active
        employee_class:
          type: string
          enum:
            - Full Time
            - Part Time
            - Temporary
            - Intern
            - Seasonal
            - Individual Contractor
          nullable: true
          description: Employment classification
        employee_start_date:
          type: string
          format: date
          nullable: true
          description: Employee start date
        employee_compensation_type:
          type: string
          enum:
            - Salary
            - Hourly
          nullable: true
          description: Compensation type
        created:
          type: string
          format: date-time
          description: Record creation timestamp
        benefit_eligibility_start_date:
          type: string
          format: date-time
          nullable: true
          description: Date when benefit eligibility starts
        enrolled_in_benefits_in:
          type: boolean
          description: Whether enrolled in any active company benefits
        user_id:
          type: string
          format: uuid
          nullable: true
          description: Associated user ID
        member_id:
          type: string
          format: uuid
          description: Associated member ID
        address:
          $ref: '#/components/schemas/Address'
        address_str_format:
          type: string
          description: Formatted address string
        first_name:
          type: string
          description: Employee first name
        middle_name:
          type: string
          nullable: true
          description: Employee middle name
        last_name:
          type: string
          description: Employee last name
        full_name:
          type: string
          description: Employee full name
        suffix:
          type: string
          enum:
            - Sr
            - Jr
            - I
            - II
            - III
            - IV
            - V
          nullable: true
          description: Name suffix
        date_of_birth:
          type: string
          format: date
          description: Employee date of birth
        sex:
          type: string
          enum:
            - Male
            - Female
            - Other
            - Unknown
          nullable: true
          description: Employee biological sex
        gender:
          type: string
          enum:
            - Male
            - Female
            - Transgender
            - Non-binary
            - Prefer not to respond
          nullable: true
          description: Employee gender identity
        email:
          type: string
          nullable: true
          description: Employee email address
        phone_number:
          type: string
          nullable: true
          description: Employee phone number
        phone:
          type: string
          nullable: true
          description: Employee phone (alternative field)
        profile_picture_url:
          type: string
          nullable: true
          description: URL to profile picture
        preferred_language:
          type: string
          enum:
            - en
            - es
            - zh
            - ru
            - sw
            - th
          default: en
          description: Employee preferred language
        age:
          type: integer
          description: Employee age
        company_id:
          type: string
          format: uuid
          description: Company identifier
        public_company_id:
          type: string
          format: uuid
          description: Public company identifier
        company_name:
          type: string
          description: Company name
        individual_income_in_cents:
          type: integer
          description: Individual income in cents
        household_income_in_cents:
          type: integer
          description: Household income in cents
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Associated tags
      required:
        - address
        - address_str_format
        - age
        - benefit_eligibility_start_date
        - company_active_in
        - company_id
        - company_name
        - created
        - date_of_birth
        - email
        - enrolled_in_benefits_in
        - first_name
        - full_name
        - id
        - member_id
    PaginationInfo:
      type: object
      properties:
        page:
          type: integer
          description: Current page number
        limit:
          type: integer
          description: Number of items per page
        total_count:
          type: integer
          description: Total number of items
        total_pages:
          type: integer
          description: Total number of pages
    Address:
      type: object
      properties:
        street_address:
          type: string
        city:
          type: string
        state:
          type: string
        zip_code:
          type: string
    Tag:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the tag
        name:
          type: string
          description: Tag name
          maxLength: 256
        description:
          type: string
          nullable: true
          description: Tag description
          maxLength: 1024
        tag_color:
          type: string
          description: Tag color
          maxLength: 7
      required:
        - id
        - name
        - tag_color
  securitySchemes:
    partnerApiKey:
      type: apiKey
      in: header
      name: X-Partner-API-Key
      description: Partner API key for external integrations

````