List execution jobs

GET

http://localhost:8080/api/v1/execution-jobs

GET

/api/v1/execution-jobs

1 curl -G http://localhost:8080/api/v1/execution-jobs \
2      -H "X-Tenant-ID: string" \
3      -H "X-Api-Key: <apiKey>" \
4      -d limit=20 \
5      -d offset=0

200api_v1_execution-jobs_List execution jobs_example

1 {
2   "code": 200,
3   "isSuccess": true,
4   "message": "success",
5   "jobs": [
6     {
7       "id": 2,
8       "provider": "revel",
9       "topic": "sync_products",
10       "tenantId": "36cce29e-8c64-a2d9-b6e6-8178c74f4e1a",
11       "outletId": "27d11d76-79a9-3c5c-499b-c700f691e50f",
12       "params": {},
13       "status": "pending",
14       "error": "string",
15       "cloudTaskName": "string",
16       "createdAt": "1955-02-27T14:05:12.975Z",
17       "updatedAt": "1991-12-14T20:11:33.870Z",
18       "startedAt": "1974-10-25T04:44:04.505Z",
19       "completedAt": "1999-03-05T05:23:17.023Z"
20     },
21     {
22       "id": 2,
23       "provider": "revel",
24       "topic": "sync_products",
25       "tenantId": "a9cee30c-bef9-7e99-0e74-0263a6da9adc",
26       "outletId": "63e338e7-d917-b768-97a2-e73dfdd0f6a6",
27       "params": {},
28       "status": "completed",
29       "error": "string",
30       "cloudTaskName": "string",
31       "createdAt": "2021-05-05T14:19:05.376Z",
32       "updatedAt": "2014-08-22T04:04:54.741Z",
33       "startedAt": "1962-03-03T14:01:09.160Z",
34       "completedAt": "1984-03-05T17:27:14.401Z"
35     }
36   ],
37   "total": 2
38 }

Returns a paginated list of async adapter execution jobs for the tenant, sorted by most recent first. Tracks provider sync operations (e.g. sync_products).

Authentication

X-Api-Keystring

API Key authentication via header

Query parameters

limitintegerOptional

Number of jobs to return per page

offsetintegerOptional

Number of jobs to skip

Response

codeinteger

jobslist of objects

totalinteger

messagestring

isSuccessboolean

Authentication

Headers

Query parameters

Response