Skip to main content
GET
List Worker Syncs

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Response

identifier
string<uuid>
required

The unique identifier of a sync.

syncName
string
required

The name of the sync.

reportProgress
boolean
required

Indicates whether the sync reports progress in percent.

configurations
object[]
required

The configuration entries of the worker sync.

salesChannelName
string

The name of the sales channel.

salesChannelId
string

The sales channel for the sync.

interval
string<duration>

The sync interval.