Sync Employees
Discover companies, paginate through employees, and maintain external system synchronization.
This guide covers discovering accessible companies, paginating through employees, and maintaining external system synchronization.
Overview
The API provides four key endpoints:
GET /companies— list accessible companies (v3)GET /api/Employees— paginate employees per company (v1)GET /api/Employees/{id}— fetch a single employee record (v1)GET /api/connected-employees— resolve cross-company relationships (v1)
Step 1 — Discover accessible companies
GET https://external-api.netchexonline.net/companies?api-version=3.0
Authorization: ApiKey YOUR_API_KEY{
"pageNumber": 1,
"pageSize": 50,
"totalItemsCount": 2,
"items": [
{ "id": 101, "name": "Acme Corp", "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" },
{ "id": 102, "name": "Acme West", "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }
]
}Filter to a specific organization using the organization-ids query parameter, or filter to known companies using company-ids.
Step 2 — Paginate employees per company
GET /api/Employees accepts either a list of employee IDs or a list of company IDs. To sync all employees for a company, use the companyId query parameter.
GET https://external-api.netchexonline.net/api/Employees?companyId=101&api-version=1.0
Authorization: ApiKey YOUR_API_KEYKey parameters:
| Parameter | Type | Description |
|---|---|---|
companyId | integer | Required. Company to list employees for |
{
"employees": [
{
"id": 5001,
"firstName": "Jane",
"lastName": "Smith",
"email": "jane.smith@acme.com",
"status": "Active",
"companyId": 101,
"hireDate": "2021-03-15"
}
],
"totalCount": 247,
"page": 1,
"pageSize": 100
}The v1 employee endpoint does not use the standard page-number/page-size kebab-case params. Use page and pageSize as camelCase query parameters.
Try it in the playground
Test these endpoints interactively in the API reference: