FAfactorialhr
Integrations > SyncableState

Reads all Syncable states

Changed on

Reads all Syncable states

get/api/2026-10-01/resources/integrations/syncable_states

Request

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

Query parameters

ids[]string[]

Filter syncable states by their identifiers

[
  "1"
]
syncable_ids[]string[]

Filter syncable states by the identifiers of the linked API resource, identified by the resource_syncable_type field

[
  "1"
]
resource_syncable_typestring

The resource of the linked records, in "namespace/resource" form. Required when filtering by syncable_ids.

Example:compensations/payroll_run_employees_compensation
integration_uuidstring

Filter syncable states by the UUID of the marketplace integration

Example:123e4567-e89b-12d3-a456-426614174000

Response

OK

Example response

{
  "data": [
    {
      "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