CampaignsList campaigns

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"
{
  "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
}
GET
/campaigns
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

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.

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
statusstring
Options: draft, active, paused, archived, completed, scheduled, failed
query
trigger_typestring
Options: event, webhook, schedule, dynamic_schedule
header
X-Workspace-IDstring
Required

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

header
Authorizationstring
Required

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

statusstring
Allowed values:draftactivepausedarchivedcompletedscheduledfailed
trigger_typestring
Allowed values:eventwebhookscheduledynamic_schedule

Headers

X-Workspace-IDstring
Required

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.

Responses

campaignsarray
totalinteger