Skip to main content
GET
/
v1
/
workers
/
status
Get Worker Status
curl --request GET \
  --url https://api.jtl-cloud.com/erp/v1/workers/status \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>'
[
  {
    "Identifier": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "State": 0,
    "ProgressText": "<string>",
    "Progress": 123,
    "LastSync": "2023-11-07T05:31:56Z",
    "NextSync": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

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

​
x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

​
x-appid
string
required

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

​
x-appversion
string
required

This is where the version number of your application is entered, e.g. "1.0.0".

​
x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

​
X-SessionId
string<uuid>

The id of a session in which the call will be executed.

​
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.

Query Parameters

​
syncId
string<uuid>

Gets the unique identifier for the configuration key. Represents a configuration key that serves as a unique identifier for configuration entities.

Response

The Status Elements of the Worker

​
Identifier
string<uuid>
required

The Unique Identifier of a Sync

​
State
enum<integer>
required

The current State of Sync

Available options:
0,
1,
2,
3,
4,
5,
6,
7
​
ProgressText
string
required

The text of Progress

​
Progress
number<double>

The Percent of Progress

​
LastSync
string<date-time>

The Time of Last Sync

​
NextSync
string<date-time>

The Time of Next Sync