Skip to content

List member employments

GET/v1/members/{member_id}/employments

Lists a member’s employment across every employer — the same employee record shape as the employer’s employees list, plus the employer name. For an organization caller the rows are scoped to companies in that organization’s book; a member (self/household) or Vitable Admin sees all employments. A member not visible to the caller returns a 404.

Path ParametersExpand Collapse
member_id: string

Unique member identifier (mbr_*)

ReturnsExpand Collapse
data: array of Employee { id, classification_effective_date, compensation_type, 20 more }
id: string

Unique employee identifier with ‘empl_’ prefix

classification_effective_date: string

Date the employee’s current classification took effect

formatdate
compensation_type: "Salary" or "Hourly"
  • Salary - Salary
  • Hourly - Hourly
One of the following:
"Salary"
"Hourly"
compensation_type_effective_date: string

Date the employee’s current compensation type took effect

formatdate
created_at: string

Timestamp when the employee was created

formatdate-time
date_of_birth: string

Date of birth (YYYY-MM-DD)

formatdate
deductions: array of { benefit_name, deduction_amount_in_cents, deduction_category, 4 more }

Payroll deductions from the most recent statement period. Replaced when a new statement is generated.

benefit_name: string

Name of the benefit plan

deduction_amount_in_cents: number

Employee deduction amount in cents

deduction_category: string

Deduction category (reserved for future use)

frequency: "weekly" or "bi_weekly" or "semi_monthly" or "monthly"
  • weekly - Weekly
  • bi_weekly - Bi Weekly
  • semi_monthly - Semi Monthly
  • monthly - Monthly
One of the following:
"weekly"
"bi_weekly"
"semi_monthly"
"monthly"
period_end_date: string

Period end date (YYYY-MM-DD)

formatdate
period_start_date: string

Period start date (YYYY-MM-DD)

formatdate
tax_classification: "Unknown" or "Pre-tax" or "Post-tax"
  • Unknown - Unknown
  • Pre-tax - Pre Tax
  • Post-tax - Post Tax
One of the following:
"Unknown"
"Pre-tax"
"Post-tax"
email: string

Email address

formatemail
employee_class: EmployeeClass
  • Full Time - Full Time
  • Part Time - Part Time
  • Temporary - Temporary
  • Intern - Intern
  • Seasonal - Seasonal
  • Individual Contractor - Individual Contractor
One of the following:
"Full Time"
"Part Time"
"Temporary"
"Intern"
"Seasonal"
"Individual Contractor"
employer_id: string

Unique identifier of the employer this employment is with (empr_*)

first_name: string

Employee’s legal first name

last_name: string

Employee’s legal last name

member_id: string

Unique member identifier with ‘mbr_’ prefix

phone: string

Phone number (10-digit US domestic string)

start_date: string

Employee’s start date with the employer

formatdate
status: "active" or "terminated"

Employee status (active or terminated)

One of the following:
"active"
"terminated"
updated_at: string

Timestamp when the employee was last updated

formatdate-time
address: optional { address_line_1, city, state, 2 more }

Employee’s residential address

address_line_1: string

Primary street address

city: string

City name

state: string

Two-letter state code (e.g., CA, NY)

zipcode: string

ZIP code (5 or 9 digit)

address_line_2: optional string

Secondary street address (apt, suite, etc.)

employer_name: optional string

Name of the employer this employment is with

gender: optional string

Gender identity, if provided

reference_id: optional string

Partner-assigned reference ID for the employee

suffix: optional string

Name suffix (e.g., Jr., Sr., III)

termination_date: optional string

Employee’s termination date, if terminated

formatdate

List member employments

curl https://api.vitablehealth.com/v1/members/$MEMBER_ID/employments \
    -H "Authorization: Bearer $VITABLE_CONNECT_API_KEY"
{
  "data": [
    {
      "id": "empl_abc123def456",
      "member_id": "mbr_abc123def456",
      "employer_name": "Acme Corp",
      "first_name": "Jane",
      "last_name": "Doe",
      "employee_class": "full_time",
      "status": "active",
      "start_date": "2024-01-15",
      "termination_date": null,
      "compensation_type": "salary"
    }
  ]
}
Returns Examples
{
  "data": [
    {
      "id": "empl_abc123def456",
      "member_id": "mbr_abc123def456",
      "employer_name": "Acme Corp",
      "first_name": "Jane",
      "last_name": "Doe",
      "employee_class": "full_time",
      "status": "active",
      "start_date": "2024-01-15",
      "termination_date": null,
      "compensation_type": "salary"
    }
  ]
}