List Campaigns
curl --request GET \
--url https://omnicommerce.sg/api/v1/campaigns \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://omnicommerce.sg/api/v1/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.sg/api/v1/campaigns"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"campaigns": [
{
"id": "<string>",
"organizationId": "<string>",
"revision": 0,
"stage": "draft",
"approval": {
"revision": 0,
"userId": "<string>",
"approvedAt": "<string>"
},
"runId": "<string>",
"startedAt": "<string>",
"endedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"brand": "<string>",
"storeCount": 4503599627370495,
"windowCount": 4503599627370495,
"offerCount": 4503599627370495,
"cleanupFailed": true
}
],
"total": 4503599627370495,
"hasMore": true,
"nextOffset": 4503599627370495,
"summary": {
"totalCount": 4503599627370495,
"stageCounts": {}
},
"pagination": {
"offset": 4503599627370495,
"limit": 4503599627370495,
"total": 4503599627370495,
"hasMore": true,
"nextOffset": 4503599627370495,
"maxLimit": 4503599627370495,
"defaultLimit": 4503599627370495
}
}Campaigns
List Campaigns
List campaigns for the authenticated organization. stage=all is the workspace working set: draft and running. Requires promotions:read.
GET
/
api
/
v1
/
campaigns
List Campaigns
curl --request GET \
--url https://omnicommerce.sg/api/v1/campaigns \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://omnicommerce.sg/api/v1/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.sg/api/v1/campaigns"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"campaigns": [
{
"id": "<string>",
"organizationId": "<string>",
"revision": 0,
"stage": "draft",
"approval": {
"revision": 0,
"userId": "<string>",
"approvedAt": "<string>"
},
"runId": "<string>",
"startedAt": "<string>",
"endedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"brand": "<string>",
"storeCount": 4503599627370495,
"windowCount": 4503599627370495,
"offerCount": 4503599627370495,
"cleanupFailed": true
}
],
"total": 4503599627370495,
"hasMore": true,
"nextOffset": 4503599627370495,
"summary": {
"totalCount": 4503599627370495,
"stageCounts": {}
},
"pagination": {
"offset": 4503599627370495,
"limit": 4503599627370495,
"total": 4503599627370495,
"hasMore": true,
"nextOffset": 4503599627370495,
"maxLimit": 4503599627370495,
"defaultLimit": 4503599627370495
}
}Authorizations
Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.
Query Parameters
Optional organization scope for session-authenticated calls. OAuth client credentials resolve the organization from the token.
Maximum string length:
120Search campaign name.
Maximum string length:
160all lists draft and running campaigns. Any other value lists that stage only.
Available options:
all, draft, approved, running, ending, completed, archived Required range:
0 <= x <= 100000Required range:
1 <= x <= 50Response
Campaign page and stage summary.