Campaigns
List campaigns
Retrieve campaigns in the workspace.
curl -X GET "https://api.flameup.ai/api/v1/workspaces/example_string/campaigns?status=draft&trigger_type=event" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://api.flameup.ai/api/v1/workspaces/example_string/campaigns?status=draft&trigger_type=event"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.flameup.ai/api/v1/workspaces/example_string/campaigns?status=draft&trigger_type=event", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
)
func main() {
req, err := http.NewRequest("GET", "https://api.flameup.ai/api/v1/workspaces/example_string/campaigns?status=draft&trigger_type=event", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.flameup.ai/api/v1/workspaces/example_string/campaigns?status=draft&trigger_type=event')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"campaigns": [
{
"id": "example_string",
"workspace_id": "example_string",
"name": "John Doe",
"status": "draft",
"trigger_type": "event",
"trigger_config": {},
"audience_config": {},
"created_at": "2024-12-25T10:00:00Z",
"updated_at": "2024-12-25T10:00:00Z"
}
],
"total": 42
}
GET
/workspaces/{workspaceId}/campaignsGET
Bearer Token
Bearer Tokenstring
RequiredYour Flameup API key (passed as Bearer token)
Your Flameup API key (passed as Bearer token)
path
workspaceIdstring
RequiredWorkspace ID
query
statusstring
Options: draft, active, paused, completed
query
trigger_typestring
Options: event, webhook, schedule, dynamic_schedule
Request Preview
Response
Response will appear here after sending the request
Authentication
header
Authorizationstring
RequiredBearer token. Your Flameup API key (passed as Bearer token)
Path Parameters
workspaceIdstring
RequiredWorkspace ID
Query Parameters
statusstring
Allowed values:
draftactivepausedcompletedtrigger_typestring
Allowed values:
eventwebhookscheduledynamic_scheduleResponses
campaignsarray
totalinteger
Was this page helpful?
Last updated 4 weeks ago
Built with Documentation.AI