List member employments

members.list_employments() -> MemberListEmploymentsResponse

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: str

Unique member identifier (mbr_*)

ReturnsExpand Collapse

class MemberListEmploymentsResponse: …

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

data: List[Employee]

id: str

Unique employee identifier with ‘empl_’ prefix

classification_effective_date: date

Date the employee’s current classification took effect

formatdate

compensation_type: Optional[Literal["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: datetime

Timestamp when the employee was created

formatdate-time

date_of_birth: date

Date of birth (YYYY-MM-DD)

formatdate

deductions: List[Deduction]

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

benefit_name: str

Name of the benefit plan

deduction_amount_in_cents: int

Employee deduction amount in cents

deduction_category: Optional[str]

Deduction category (reserved for future use)

frequency: Literal["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: Literal["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: str

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: str

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

first_name: str

Employee’s legal first name

last_name: str

Employee’s legal last name

member_id: str

Unique member identifier with ‘mbr_’ prefix

phone: Optional[str]

Phone number (10-digit US domestic string)

start_date: date

Employee’s start date with the employer

formatdate

status: Literal["active", "terminated"]

Employee status (active or terminated)

One of the following:

"active"

"terminated"

updated_at: datetime

Timestamp when the employee was last updated

formatdate-time

address: Optional[Address]

Employee’s residential address

address_line_1: str

Primary street address

city: str

City name

state: str

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

zipcode: str

ZIP code (5 or 9 digit)

address_line_2: Optional[str]

Secondary street address (apt, suite, etc.)

employer_name: Optional[str]

Name of the employer this employment is with

gender: Optional[str]

Gender identity, if provided

reference_id: Optional[str]

Partner-assigned reference ID for the employee

suffix: Optional[str]

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

termination_date: Optional[date]

Employee’s termination date, if terminated

formatdate

List member employments

import os
from vitable_connect import VitableConnect

client = VitableConnect(
    api_key=os.environ.get("VITABLE_CONNECT_API_KEY"),  # This is the default and can be omitted
)
response = client.members.list_employments(
    "mbr_abc123def456",
)
print(response.data)

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