v1

latestOpenAPI 3.0.22026-07-26480119.6 KB

Eligibles

Enqueue a bulk transfer of eligible employees to a different company

Enqueues an asynchronous operation to move multiple eligible employees from their current company to a destination company within the same company group. The operation is processed asynchronously — use GET /api/v1/operations/{id} to track progress. Maximum of 200 items per request.

post/api/v1/eligibles/bulk_transfer

Request body

sourcestring

Optional identifier for the request origin

Example request

{
  "source": "hr-system",
  "data": [
    {
      "eligible_identifier": "12345678901",
      "future_company_identifier": "98765432000100"
    }
  ]
}

Response

Operation enqueued successfully

idinteger required

Operation ID used to track progress

created_atstring date-time required

status'pending' | 'processing' | 'finished' | 'finished_with_errors' | 'invalidated' required

Example response

{
  "id": 44,
  "created_at": "2026-05-21T10:00:00.000Z",
  "status": "pending"
}