TOtotalpass
Operations

Retrieve operation details with items

Returns the current status of an asynchronous operation along with the processing result of each individual item. Use this endpoint to poll the outcome of bulk_create, bulk_delete, or bulk_transfer requests.

get/api/v1/operations/{id}

Request

  • Base URL
    https://company-eligibles-api.totalpass.com
  • URL
    https://company-eligibles-api.totalpass.com/api/v1/operations/{id}
  • Auth
    HTTP bearer

Path parameters

idinteger required

Operation ID returned when the bulk operation was enqueued

Response

Operation with items returned

idinteger required
created_atstring date-time required
status'pending' | 'processing' | 'finished' | 'finished_with_errors' | 'invalidated' required

Example response

{
  "id": 42,
  "created_at": "2026-05-21T10:00:00.000Z",
  "status": "finished",
  "operation_items": [
    {
      "status": "finished",
      "eligible_identifier": "12345678901",
      "company_identifier": "12345678000195",
      "error_message": "Employee not found in company"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.