List campaigns
Retrieve campaigns in the workspace.
curl -X GET "https://api.flameup.ai/api/v1/campaigns?status=draft&trigger_type=event" \
-H "Content-Type: application/json" \
-H "X-Workspace-ID: example_string" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://api.flameup.ai/api/v1/campaigns?status=draft&trigger_type=event"
headers = {
"Content-Type": "application/json",
"X-Workspace-ID": "example_string",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.flameup.ai/api/v1/campaigns?status=draft&trigger_type=event", {
method: "GET",
headers: {
"Content-Type": "application/json",
"X-Workspace-ID": "example_string",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.flameup.ai/api/v1/campaigns?status=draft&trigger_type=event", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-Workspace-ID", "example_string")
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/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['X-Workspace-ID'] = 'example_string'
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": {
"event_names": [
"John Doe"
],
"filters": [
{
"field": "example_string",
"operator": "eq",
"value": "null"
}
],
"properties": {},
"debounce": 3.14,
"delay_minutes": 3.14,
"max_per_user": 42,
"first_occurrence": true
},
"audience_config": {},
"created_at": "2024-12-25T10:00:00Z",
"updated_at": "2024-12-25T10:00:00Z"
}
],
"total": 42
}
/campaigns
Target server for requests. Edit to use your own host.
A Firebase ID token from a signed-in dashboard session. Endpoints using this scheme are NOT callable with an API key and will reject one.
The workspace to operate on, for dashboard routes that carry no workspace_id path segment. A workspace_id query parameter is accepted as an alternative; either way the value is checked against the signed-in user's workspace membership before it is trusted.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. A Firebase ID token from a signed-in dashboard session. Endpoints using this scheme are NOT callable with an API key and will reject one.
Query Parameters
draftactivepausedarchivedcompletedscheduledfailedeventwebhookscheduledynamic_scheduleHeaders
The workspace to operate on, for dashboard routes that carry no workspace_id path segment. A workspace_id query parameter is accepted as an alternative; either way the value is checked against the signed-in user's workspace membership before it is trusted.