Sign in
integrations

getEntitySyncStatus

Get the inbound ERP sync status of an entity: when each integration last synchronized (checked) the entity against the ERP, and when it last actually changed it. last_synced_at also advances on no-op checks — events that were received and evaluated but changed nothing — which by design leave no trace on the entity itself (no activity feed entry, no _updated_at bump). Use it to tell whether an entity is up to date with the ERP. Returns an empty list for entities no inbound use case has processed. Org-scoped via the caller's token.

Deprecated alias: GET /v1/entities/{entityId}/sync-status is still served (rewritten to this path in the API handler) but will be removed — migrate callers to this path.

get/v1/integrations/entities/{entityId}/sync-status

Path parameters

entityIdstring uuid required

The entity ID

Query parameters

integration_idstring uuid

Narrow the result to a single integration

Response

Successfully retrieved entity sync status

entity_idstring uuid required

The entity the sync states belong to

Example response

{
  "sync_states": [
    {
      "entity_slug": "contract"
    }
  ]
}

Changes

Changed in 1 of the 11 revisions of this API.1