API v2 employee release
Employees and credentials
- Public workspace paths use
/c/{companyId}and accept a stable company ID or a workspace slug. Credentials remain workspace-scoped. - API-key requests use
Authorization: Bearer <key>. Keys respect the creator’s current permissions and their read or read/write access. - Employee creation uses
primaryEmailand creates new records only. Existing current or former employees return409; use the employment-status operation for a rehire. - Explicit ownership claims on employee updates use
claimOwnership.
Field sources
- Public routes use
/field-sources/available-sources,/field-sources/defaults, and/field-sources/resolvewithin the workspace path. - Employee-specific routes use
/employees/{employeeId}/field-sources. - Public source identifiers use normalized names such as
bamboo-hr,google-workspace, andjust-works. Start with List available employee field sources.
Pagination and limits
Profile search defaults to 20 results and allows up to 100 per page. ID search defaults to and allows up to 1,000. Both returnhasMore; totals are opt-in.
The API-client budget is 500 requests per minute per API key, or per OAuth client and workspace. Limited requests return 429 with RATE_LIMITED in the standard error envelope and a Retry-After header. See Rate limits.