Quickstart - Soundlink API

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

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

Expected:

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

Ping accepts any valid key scope (campaigns:read and/or metrics:read).

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

Requires the campaigns:read scope on your key.

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