List employees
Retrieves a paginated list of employees for a specific employer. The caller must be authorized for the employer; an unknown or unauthorized employer returns 404. Results are paginated using page and limit parameters and can be narrowed with a case-insensitive search (first name, last name, or email) and an employment_status filter (active or terminated). Each employee includes payroll deductions from the most recent statement period. When a new deduction statement is generated, previous period deductions are replaced.
Request
- Base URL: https://api.vitablehealth.com
- URL: https://api.vitablehealth.com/v1/employers/{employer_id}/employees
- Auth: HTTP bearer
Path parameters
Unique employer identifier (empr_*)
Query parameters
Filter by employment status (active or terminated)
Items per page (default: 20, max: 100)
Page number (default: 1)
Case-insensitive search across employee first name, last name, and email
Headers
Organization to act as for this request (e.g. org_SGVsbG8gV29ybGQ). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 organization_required. A malformed value returns 400 invalid_organization_header, and naming an organization you do not have access to returns 403 organization_access_denied.
Response
Changes
No recorded changes to this operation across all 1 revision of this API.