FAfactorialhr
Integrations > SyncableState

Reads a single Syncable state

Changed on

Reads a single Syncable state

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

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/integrations/syncable_states/{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

Filter syncable states by their identifiers

Response

OK

idstring required

Identifier of the syncable state

syncable_idstring

Identifier of the Factorial record this state is linked to

resource_syncable_typestring required

The resource of the linked record, in "namespace/resource" form. Combined with syncable_id, uniquely identifies the Factorial record this state is linked to.

integration_uuidstring required

UUID of the marketplace integration

status'synced' | 'syncing' | 'outdated' | 'invalid' | 'failed' required

Synchronization status of the record

status_updated_atstring required

Timestamp of the last status change

external_identifierstring

Identifier of the record in the external system

syncable_deleted_atstring

Timestamp when the linked Factorial record was deleted, if any

sync_type'compensations/compensation' | 'expenses/expense' | 'employee_updates/contract_change' | 'employee_updates/leave' | 'employee_updates/new_hire' | 'employee_updates/personal_change_id' | 'employee_updates/personal_change_name' | 'employee_updates/personal_change_irpf' | 'employee_updates/personal_change_bank' | 'employee_updates/personal_change_gender' | 'employee_updates/personal_change_health_insurance' | 'employee_updates/personal_change_address' | 'employee_updates/personal_change_residence' | 'employee_updates/personal_change_workplace' | 'employee_updates/personal_change_nationality' | 'employee_updates/personal_change_email' | 'employee_updates/personal_change_phone_number' | 'employee_updates/personal_change_permits_and_certificates' | 'employee_updates/personal_change_taxes_and_deductions' | 'employee_updates/personal_change_work_activity' | 'employee_updates/personal_change_birth_name' | 'employee_updates/personal_change_academic_title' | 'employee_updates/personal_change_country_of_birth' | 'employee_updates/personal_change_place_of_birth' | 'employee_updates/termination' | 'employee_updates/worked_time' | 'finance/vendor' required

The type of synchronization this state represents, in "namespace/resource" form. Describes what is being synced independently of the resource_syncable_type that carries the id.

Example response

{
  "id": "1",
  "syncable_id": "1",
  "resource_syncable_type": "compensations/payroll_run_employees_compensation",
  "integration_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "status": "synced",
  "error_messages": [
    {
      "key": "sync_api_error",
      "value": "Api sync error"
    }
  ],
  "status_updated_at": "2026-07-01T00:00:00.000Z",
  "external_identifier": "ext-12345",
  "sync_type": "compensations/compensation"
}

Changes