CampaignsList campaigns
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"
{
  "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}/campaigns
GET
Security Scheme
Bearer Token
Bearer Tokenstring
Required

Your Flameup API key (passed as Bearer token)

Your Flameup API key (passed as Bearer token)
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

BearerAuth
header
Authorizationstring
Required

Bearer token. Your Flameup API key (passed as Bearer token)

Path Parameters

Query Parameters

Responses

campaignsarray
totalinteger
Was this page helpful?
Built with Documentation.AI

Last updated today