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.
Authentication
AuthorizationBearer
API Key or Access Token authentication using Bearer token in Authorization header. API keys use the vit_apk_ prefix, access tokens use the vit_at_ prefix.
Path parameters
employer_id
Unique employer identifier (empr_*)
Headers
X-Vitable-Organization
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`.
Query parameters
employment_status
Filter by employment status (active or terminated)
Allowed values:
limit
Items per page (default: 20, max: 100)
page
Page number (default: 1)
search
Case-insensitive search across employee first name, last name, and email
Response headers
X-RateLimit-Limit
Maximum number of requests allowed within the rate limit window
X-RateLimit-Remaining
Number of requests remaining in the current rate limit window
X-RateLimit-Reset
Unix timestamp (seconds) when the rate limit window resets
Response
data
This page of employees.
pagination
Page metadata. Request the next page by incrementing page.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error