Skip to main content
Use the Campaigns API to discover which campaigns belong to your organization and pull metadata for reporting joins.

​
List campaigns

GET /v1/campaigns Requires campaigns:read. Supports pagination:
Walk pages until pagination.page >= pagination.totalPages.

​
Campaign detail

GET /v1/campaigns/{campaignId} Returns full metadata for one campaign: name, status, target type (track or playlist), dates, and identifiers you need to join metrics rows. Both list and detail rows include generation — a resource version for the campaign (1 Stripe/legacy, 2 managed, 3 wallet). Only generation 3 can be managed via the API (budget changes, tier updates, stop). Use the campaignId from the list response in all /metrics/* paths.

​
Typical sync flow

  1. Daily: GET /v1/campaigns — upsert catalog
  2. Daily: export or paginated metrics per active campaign
  3. Warehouse: join metrics on campaign_id + account_id (your organization UUID from each row)

​
Organization scope

Your organization is determined only from the API key. You never pass organization_id in query params — rows already include account_id for your org.
Node.js users can paginate campaigns with soundlink.campaigns.listAll() — see TypeScript SDK.

​
Next

Understanding metrics → JSONL exports