List member employments

members.list_employments(member_id) -> MemberListEmploymentsResponse { data }

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.

ParametersExpand Collapse

member_id: String

Unique member identifier (mbr_*)

ReturnsExpand Collapse

class MemberListEmploymentsResponse { data }

Unpaginated {"data": [...]} list of member employments.

data: Array[Employee { id, classification_effective_date, compensation_type, 20 more } ]

id: String

Unique employee identifier with ‘empl_’ prefix

classification_effective_date: Date

Date the employee’s current classification took effect

formatdate

compensation_type: :Salary | :Hourly

Salary - Salary
Hourly - Hourly

One of the following:

:Salary

:Hourly

compensation_type_effective_date: Date

Date the employee’s current compensation type took effect

formatdate

created_at: Time

Timestamp when the employee was created

formatdate-time

date_of_birth: Date

Date of birth (YYYY-MM-DD)

formatdate

deductions: Array[{ 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: Integer

Employee deduction amount in cents

deduction_category: String

Deduction category (reserved for future use)

frequency: :weekly | :bi_weekly | :semi_monthly | :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: Date

Period end date (YYYY-MM-DD)

formatdate

period_start_date: Date

Period start date (YYYY-MM-DD)

formatdate

tax_classification: :Unknown | :"Pre-tax" | :"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: Date

Employee’s start date with the employer

formatdate

status: :active | :terminated

Employee status (active or terminated)

One of the following:

:active

:terminated

updated_at: Time

Timestamp when the employee was last updated

formatdate-time

address: { 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: String

Secondary street address (apt, suite, etc.)

employer_name: String

Name of the employer this employment is with

gender: String

Gender identity, if provided

reference_id: String

Partner-assigned reference ID for the employee

suffix: String

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

termination_date: Date

Employee’s termination date, if terminated

formatdate

List member employments

require "vitable_connect"

vitable_connect = VitableConnect::Client.new(
  api_key: "My API Key",
  environment: "environment_1" # defaults to "production"
)

response = vitable_connect.members.list_employments("mbr_abc123def456")

puts(response)

{
  "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"
    }
  ]
}