Quickstart

Get your first successful API response in a few minutes with curl. Using Node.js or TypeScript? See Access the API with TypeScript instead.

Prerequisites

A Soundlink account with owner or admin access to your organization
An API key (sk_*) — create one in the app (below) or use an existing key

Create an API key

Step-by-step in Settings → Developer → API keys — name, expiration, scopes, and one-time copy. Includes screenshots.

Open in Soundlink

Keys need at least one scope and an expiration choice — a fixed preset (7 days to 1 year) or Never. See Authentication for details.

1. Ping (connectivity)

Replace sk_YOUR_PREFIX_YOUR_SECRET with the key you copied from the Save your API key dialog:

curl -sS 'https://api.getsoundlink.com/v1/ping' \
  -H 'Authorization: Bearer sk_YOUR_PREFIX_YOUR_SECRET'

Expected:

{
  "data": { "status": "ok" },
  "meta": { "requestId": "..." }
}

Ping accepts any valid key regardless of scopes — useful as a smoke test right after creating a key.

2. List campaigns

Requires the campaigns:read scope on your key.

curl -sS 'https://api.getsoundlink.com/v1/campaigns?page=1&pageSize=10' \
  -H 'Authorization: Bearer sk_YOUR_PREFIX_YOUR_SECRET'

3. Create a campaign (optional)

With the campaigns:write scope you can also create a wallet-funded campaign. The Idempotency-Key header is required — retries with the same key never double-charge:

curl -sS -X POST 'https://api.getsoundlink.com/v1/campaigns' \
  -H 'Authorization: Bearer sk_YOUR_PREFIX_YOUR_SECRET' \
  -H 'Idempotency-Key: my-first-campaign-01' \
  -H 'Content-Type: application/json' \
  -d '{
    "spotifyUrl": "https://open.spotify.com/track/YOUR_TRACK_ID",
    "dailyBudget": 25,
    "durationDays": 14,
    "genre": "Pop",
    "strategyType": "maximum_growth"
  }'

This deducts dailyBudget × durationDays from your wallet balance. See Creating campaigns for all fields and rules, and Managing campaigns to adjust budget or stop it later.

4. Use requestId for support

If something fails, include meta.requestId from the error response when contacting Soundlink support. See Errors for common codes.

Read pipelines: Syncing campaigns → Understanding metrics → JSONL exports
Write flows: Creating campaigns → Managing campaigns

Get started

For Developers

Learn

Prerequisites

Create an API key

Open in Soundlink

1. Ping (connectivity)

2. List campaigns

3. Create a campaign (optional)

4. Use requestId for support

Next

​Prerequisites

Create an API key

Open in Soundlink

​1. Ping (connectivity)

​2. List campaigns

​3. Create a campaign (optional)

​4. Use requestId for support

​Next

Prerequisites

1. Ping (connectivity)

2. List campaigns

3. Create a campaign (optional)

4. Use requestId for support

Next