Campaigns

List the token owner's campaigns with headline analytics

Lists the campaigns you own with their headline analytics, newest first. Campaigns delegated to you, and campaigns your team's visibility settings share with you, are NOT listed: every other endpoint in this family resolves the token owner's own campaigns only, so listing them would hand back ids that answer 404 everywhere else. createdBy is the campaign's owner and is therefore always the token owner. Deleted campaigns are never returned. Engagement rates are percentages of messages sent. Rate limit: 30 requests/minute and 1,000/day per token owner, shared by every campaign, scheduled-send, campaign-template and knowledge-hub endpoint.

Errors:

  • 422 VALIDATION_FAILED — A query parameter is out of range or not one of the accepted values; param names it.
  • 429 RATE_LIMITED — More than 30 campaign requests in a minute, or 1,000 in a day, for this token owner (the bucket is shared by every /business/campaigns, /business/scheduled-sends, /business/campaign-templates and /business/knowledge-hubs call).
  • 500 UNEXPECTED_ERROR — An unhandled failure; the detail stays in our logs and is never returned.

Requires one of the following token scopes: campaigns.

get/business/campaigns

Request

  • Base URL: https://api.tryfuse.ai/api/v1
  • URL: https://api.tryfuse.ai/api/v1/business/campaigns
  • Auth: HTTP basic

Query parameters

limitinteger

Page size, 1-100 (default 25).

pageNuminteger

1-based page number (default 1).

searchstring

Free text matched case-insensitively against the campaign name only (1-200 characters); any string is accepted. The value reaches the store as a regular expression rather than a literal, so metacharacters such as ( ) [ ] + * ? | are interpreted — send plain words, or escape them. A term that matches no campaign returns an empty page, not an error.

type'ai-generated' | 'manual'

Restrict to ai-generated or manual campaigns — the same values a campaign's type reports.

status'active' | 'initializing' | 'initialization_failed' | 'stopped' | 'paused_manual'

Restrict to one status: initializing (draft, not yet approved), active (approved and sending), stopped (stopped via /stop or deleted), paused_manual (paused by the app), initialization_failed (AI initialization failed; see initializationError).

folderIdstring

Return only campaigns filed in this sequences folder (see GET /business/folders).

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.