Integrations > SyncRun

Reads a single Sync run

Changed on

Reads a single Sync run

get/api/2026-10-01/resources/integrations/sync_runs/{id}

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/integrations/sync_runs/{id}
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token
    • or API key in header x-api-key

Path parameters

idstring required

identifier of sync run

Response

OK

idstring required

Identifier of the sync run

status'succeeded' | 'running' | 'errored' | 'succededwitherrors' required

Status of the sync run

started_atstring required

Timestamp when the sync run started

finished_atstring

Timestamp when the sync run finished

company_idstring required

Identifier of the company

integration_uuidstring required

UUID of the marketplace integration

Example response

{
  "id": "1",
  "status": "succeeded",
  "started_at": "2026-07-01T18:05:45.000Z",
  "finished_at": "2026-07-01T18:10:12.000Z",
  "context": {
    "from": "2026-01-01",
    "to": "2026-01-31"
  },
  "company_id": "1",
  "integration_uuid": "123e4567-e89b-12d3-a456-426614174000"
}

Changes