List campaigns

GET

campaigns

List campaigns

curl --request GET \
  --url https://api.getsoundlink.com/v1/campaigns \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.getsoundlink.com/v1/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "items": [
      {
        "campaignId": "f1e28d31-c358-4284-9bef-00a2334625fd",
        "organizationId": "org_xyz",
        "status": "active",
        "socialPlatform": "meta",
        "dailyBudget": 20,
        "totalBudget": 140,
        "campaignDuration": 7,
        "createdAt": "2026-04-01T10:00:00Z",
        "updatedAt": "2026-04-08T12:00:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "pageSize": 10,
      "totalCount": 42,
      "totalPages": 5
    }
  },
  "meta": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Authorizations

x-api-key

string

header

required

Pass your Soundlink sk_* API key in the x-api-key header. Keys can carry explicit scopes (for example campaigns:read, metrics:read, videos:write) enforced by the backend.

Deprecated, retiring 2026-08-17 — migrate to Authorization: Bearer sk_... (see apiKeyBearerAuth) before then.

Query Parameters

page

integer

default:1

Page number (1-indexed)

Required range: x >= 1

pageSize

integer

default:10

Items per page (max 100)

Required range: 1 <= x <= 100

sortBy

enum<string>

default:createdAt

Available options:

createdAt

sortOrder

enum<string>

default:desc

Sort direction

Available options:

asc,

desc

Response

Paginated list of campaigns

data

object

required

Show child attributes

meta

object

required

Show child attributes

List campaigns

curl --request GET \
  --url https://api.getsoundlink.com/v1/campaigns \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.getsoundlink.com/v1/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "items": [
      {
        "campaignId": "f1e28d31-c358-4284-9bef-00a2334625fd",
        "organizationId": "org_xyz",
        "status": "active",
        "socialPlatform": "meta",
        "dailyBudget": 20,
        "totalBudget": 140,
        "campaignDuration": 7,
        "createdAt": "2026-04-01T10:00:00Z",
        "updatedAt": "2026-04-08T12:00:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "pageSize": 10,
      "totalCount": 42,
      "totalPages": 5
    }
  },
  "meta": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

System

Campaigns

Metrics

Videos

Authorizations

Query Parameters

Response