List campaigns
curl --request GET \
--url https://api.sigmora.org/v1/campaigns \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sigmora.org/v1/campaigns"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sigmora.org/v1/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"campaigns": [
{
"id": "<string>",
"title": "<string>",
"description": "<string>",
"connectedAccountIds": [
"<string>"
],
"platforms": [
"tiktok"
],
"automationMode": "manual",
"status": "draft",
"scheduledAt": "2023-11-07T05:31:56Z",
"remixJobIds": [
"<string>"
],
"playbookId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"projectIds": [
"<string>"
],
"agentId": "<string>",
"assetCount": 4503599627370495
}
],
"hasMore": true,
"nextCursor": "<string>"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}List campaigns
List this workspace’s campaigns. Includes campaigns created by first-party marketing agents and by API clients.
GET
/
v1
/
campaigns
List campaigns
curl --request GET \
--url https://api.sigmora.org/v1/campaigns \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sigmora.org/v1/campaigns"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sigmora.org/v1/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"campaigns": [
{
"id": "<string>",
"title": "<string>",
"description": "<string>",
"connectedAccountIds": [
"<string>"
],
"platforms": [
"tiktok"
],
"automationMode": "manual",
"status": "draft",
"scheduledAt": "2023-11-07T05:31:56Z",
"remixJobIds": [
"<string>"
],
"playbookId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"projectIds": [
"<string>"
],
"agentId": "<string>",
"assetCount": 4503599627370495
}
],
"hasMore": true,
"nextCursor": "<string>"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}{
"success": false,
"error": "<string>",
"code": "invalid_request",
"details": "<unknown>",
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}Authorizations
A workspace API key.
Query Parameters
Filter by lifecycle state. all returns every campaign.
Available options:
draft, scheduled, active, paused, completed, all How many campaigns to return. Between 1 and 100; defaults to 50.
Required range:
1 <= x <= 100Opaque continuation from nextCursor, bound to this user, workspace, and status filter.
Maximum string length:
1024