## List employees `employers.list_employees(stremployer_id, EmployerListEmployeesParams**kwargs) -> SyncPageNumberPage[Employee]` **get** `/v1/employers/{employer_id}/employees` Retrieves a paginated list of all employees for a specific employer. Results are paginated using page and limit parameters. ### Parameters - `employer_id: str` Unique employer identifier (empr_*) - `limit: Optional[int]` Items per page (default: 20, max: 100) - `page: Optional[int]` Page number (default: 1) ### Returns - `class Employee: …` - `id: str` Unique employee identifier with 'empl_' prefix - `created_at: datetime` Timestamp when the employee was created - `date_of_birth: date` Date of birth (YYYY-MM-DD) - `email: str` Email address - `enrollments: List[Enrollment]` Benefit enrollments for this employee - `id: str` Unique enrollment identifier with 'enrl_' prefix - `status: EnrollmentStatus` * `pending` - Pending * `enrolled` - Enrolled * `waived` - Waived * `inactive` - Inactive - `"pending"` - `"enrolled"` - `"waived"` - `"inactive"` - `answered_at: Optional[datetime]` Timestamp when the enrollment decision was made - `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 - `status: str` Employee status (active or terminated) - `updated_at: datetime` Timestamp when the employee was last updated - `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.) - `employee_class: Optional[EmployeeClass]` * `Full Time` - Full Time * `Part Time` - Part Time * `Temporary` - Temporary * `Intern` - Intern * `Seasonal` - Seasonal * `Individual Contractor` - Individual Contractor - `"Full Time"` - `"Part Time"` - `"Temporary"` - `"Intern"` - `"Seasonal"` - `"Individual Contractor"` - `gender: Optional[str]` Gender identity, if provided - `hire_date: Optional[date]` Employee's hire date with the employer - `phone: Optional[str]` Phone number (10-digit US domestic string) - `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 ### Example ```python 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 ) page = client.employers.list_employees( employer_id="empr_abc123def456", ) page = page.data[0] print(page.id) ``` #### Response ```json { "data": [ { "id": "empl_abc123", "member_id": "mbr_xyz789", "reference_id": "partner-ee-001", "first_name": "John", "last_name": "Doe", "suffix": null, "email": "john.doe@example.com", "date_of_birth": "1985-06-15", "gender": null, "phone": "4155551234", "employee_class": "Full Time", "status": "active", "hire_date": "2023-01-15", "termination_date": null, "address": { "address_line_1": "456 Oak Avenue", "address_line_2": "Apt 2B", "city": "San Francisco", "state": "CA", "zipcode": "94102" }, "enrollments": [ { "id": "enrl_abc123", "status": "enrolled", "answered_at": "2023-01-20T10:00:00Z" } ], "created_at": "2023-01-15T09:00:00Z", "updated_at": "2024-06-01T14:30:00Z" } ], "pagination": { "page": 1, "limit": 20, "total": 1, "total_pages": 1 } } ```