Retrieving all company employees via API
The Employees endpoint returns workforce identity records for the authenticated workspace. Use pagination for predictable synchronization as the company grows.
Keep API credentials server-side.
Do not expose production tokens in browser code, public repositories or shared client-side configuration.
Request
Use page and per_page for pagination. Optional status and department filters can reduce the response to the records your workflow needs.
GET https://api.worklix.com/v1/employees?page=1&per_page=50&status=activeExample response
List responses include pagination metadata so the integration can continue until all pages are processed.
{
"data": [
{ "id": "emp_1042", "name": "Jordan Lee", "department": "Support", "status": "active" }
],
"meta": { "page": 1, "per_page": 50, "total": 128, "next_page": 2 }
}Synchronization guidance
Store the Worklix employee ID as the stable integration key. Avoid matching only by display name, which can change or collide.
Was this article helpful?