List employees for a company

curl --request GET \
  --url https://api.vitablehealth.com/v1/company-members \
  --header 'X-Partner-API-Key: <api-key>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "company_active_in": true,
      "created": "2023-11-07T05:31:56Z",
      "benefit_eligibility_start_date": "2023-11-07T05:31:56Z",
      "enrolled_in_benefits_in": true,
      "member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "address": {
        "street_address": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip_code": "<string>"
      },
      "address_str_format": "<string>",
      "first_name": "<string>",
      "full_name": "<string>",
      "date_of_birth": "2023-12-25",
      "email": "<string>",
      "age": 123,
      "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "company_name": "<string>",
      "hris_id": "<string>",
      "type": "Employee",
      "active_in": true,
      "employee_class": "Full Time",
      "employee_start_date": "2023-12-25",
      "employee_compensation_type": "Salary",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "middle_name": "<string>",
      "last_name": "<string>",
      "suffix": "Sr",
      "sex": "Male",
      "gender": "Male",
      "phone_number": "<string>",
      "phone": "<string>",
      "profile_picture_url": "<string>",
      "preferred_language": "en",
      "public_company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "individual_income_in_cents": 123,
      "household_income_in_cents": 123,
      "tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "tag_color": "<string>",
          "description": "<string>"
        }
      ]
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total_count": 123,
    "total_pages": 123
  }
}

GET

company-members

curl --request GET \
  --url https://api.vitablehealth.com/v1/company-members \
  --header 'X-Partner-API-Key: <api-key>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "company_active_in": true,
      "created": "2023-11-07T05:31:56Z",
      "benefit_eligibility_start_date": "2023-11-07T05:31:56Z",
      "enrolled_in_benefits_in": true,
      "member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "address": {
        "street_address": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip_code": "<string>"
      },
      "address_str_format": "<string>",
      "first_name": "<string>",
      "full_name": "<string>",
      "date_of_birth": "2023-12-25",
      "email": "<string>",
      "age": 123,
      "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "company_name": "<string>",
      "hris_id": "<string>",
      "type": "Employee",
      "active_in": true,
      "employee_class": "Full Time",
      "employee_start_date": "2023-12-25",
      "employee_compensation_type": "Salary",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "middle_name": "<string>",
      "last_name": "<string>",
      "suffix": "Sr",
      "sex": "Male",
      "gender": "Male",
      "phone_number": "<string>",
      "phone": "<string>",
      "profile_picture_url": "<string>",
      "preferred_language": "en",
      "public_company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "individual_income_in_cents": 123,
      "household_income_in_cents": 123,
      "tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "tag_color": "<string>",
          "description": "<string>"
        }
      ]
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total_count": 123,
    "total_pages": 123
  }
}

Authorizations

X-Partner-API-Key

string

header

required

Partner API key for external integrations

Query Parameters

company_id

string<uuid>

required

Filter by company ID

active_in

boolean

Filter for active employees only

benefits_eligible_in

boolean

Filter for benefit-eligible employees only

employee_class

enum<string>

Filter by employment classification

Available options:

Full Time,

Part Time,

Temporary,

Intern,

Seasonal,

Individual Contractor

limit

integer

default:20

Number of results to return per page

page

integer

default:1

Page number for pagination

Response

200 - application/json

List of company members

data

object[]

Show child attributes

data.id

string<uuid>

required

Unique identifier for the company member

data.company_active_in

boolean

required

Indicates whether the company is active

data.created

string<date-time>

required

Record creation timestamp

data.benefit_eligibility_start_date

string<date-time> | null

required

Date when benefit eligibility starts

data.enrolled_in_benefits_in

boolean

required

Whether enrolled in any active company benefits

data.member_id

string<uuid>

required

Associated member ID

data.address

object

required

Show child attributes

data.address.street_address

string

data.address.city

string

data.address.state

string

data.address.zip_code

string

data.address_str_format

string

required

Formatted address string

data.first_name

string

required

Employee first name

data.full_name

string

required

Employee full name

data.date_of_birth

string<date>

required

Employee date of birth

data.email

string | null

required

Employee email address

data.age

integer

required

Employee age

data.company_id

string<uuid>

required

Company identifier

data.company_name

string

required

Company name

data.hris_id

string | null

External HRIS identifier

data.type

enum<string>

Type of company member

Available options:

Employee,

Recruit,

Youth

data.active_in

boolean

Indicates whether this company member is active

data.employee_class

enum<string> | null

Employment classification

Available options:

Full Time,

Part Time,

Temporary,

Intern,

Seasonal,

Individual Contractor

data.employee_start_date

string<date> | null

Employee start date

data.employee_compensation_type

enum<string> | null

Compensation type

Available options:

Salary,

Hourly

data.user_id

string<uuid> | null

Associated user ID

data.middle_name

string | null

Employee middle name

data.last_name

string

Employee last name

data.suffix

enum<string> | null

Name suffix

Available options:

Sr,

Jr,

I,

II,

III,

IV,

V

data.sex

enum<string> | null

Employee biological sex

Available options:

Male,

Female,

Other,

Unknown

data.gender

enum<string> | null

Employee gender identity

Available options:

Male,

Female,

Transgender,

Non-binary,

Prefer not to respond

data.phone_number

string | null

Employee phone number

data.phone

string | null

Employee phone (alternative field)

data.profile_picture_url

string | null

URL to profile picture

data.preferred_language

enum<string>

default:en

Employee preferred language

Available options:

en,

es,

zh,

ru,

sw,

th

data.public_company_id

string<uuid>

Public company identifier

data.individual_income_in_cents

integer

Individual income in cents

data.household_income_in_cents

integer

Household income in cents

data.tags

object[]

Associated tags

Show child attributes

data.tags.id

string<uuid>

required

Unique identifier for the tag

data.tags.name

string

required

Tag name

Maximum string length: 256

data.tags.tag_color

string

required

Tag color

Maximum string length: 7

data.tags.description

string | null

Tag description

Maximum string length: 1024

pagination

object

Show child attributes

pagination.page

integer

Current page number

pagination.limit

integer

Number of items per page

pagination.total_count

integer

Total number of items

pagination.total_pages

integer

Total number of pages

List eligible expense categories by benefit type Get employee details

⌘I

Introduction

Benefits

Employees

Enrollments

Member Benefits

Benefit Eligibility

Payroll Integration

Quoting

List employees for a company

Authorizations

Query Parameters

Response