v46

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011274550.0 KB
Employees

List Employees

List all employees for a given employer with pagination.

get/v1/employees

Query parameters

employerIdstring required

ID of the employer to list employees for

limitstring

Maximum number of employees to return (default: 50)

offsetstring

Number of employees to skip (default: 0)

searchstring

Search term to filter employees by first name, last name, or email (case-insensitive)

activeAccount'Active' | 'Inactive'

Filter by account status. If omitted, returns all employees regardless of status.

Response

Employees retrieved successfully

successboolean required
totalnumber required

Total number of employees returned

messagestring required