Skip to main content
Soundlink’s Public API lets partner organizations sync campaigns and metrics into their own tools and data warehouses.

​
Get started

REST API

Verify your key with curl, then list campaigns. Works with Python, BigQuery, Airflow, or any HTTP client.

TypeScript SDK

Official soundlink package for Node.js, serverless, and Edge — typed methods, pagination helpers, and JSONL streaming.
Not sure which to pick? See Official SDKs for a side-by-side comparison.

​
Guides

Syncing campaigns

List campaigns, pagination, and warehouse join patterns.

Understanding metrics

Overview vs breakdown vs engagement — which endpoint to call.

JSONL exports

Bulk metrics downloads, 90-day windows, and ingest patterns.

API Reference

Full OpenAPI spec, schemas, and interactive playground.

​
Reference

Authentication

API key format, scopes, and organization isolation.

Errors

Error codes, HTTP status mapping, and pagination limits.

​
API basics

https://api.getsoundlink.com
All v1 routes live under /v1/*.
Send your API key on every request:
x-api-key: sk_<prefix>_<secret>
See Authentication for scopes and security.
Successful responses:
{
  "data": {},
  "meta": { "requestId": "550e8400-e29b-41d4-a716-446655440000" }
}
Errors use the same shape with an error field instead of data. See Errors.
All createdAt and updatedAt fields are UTC (ISO 8601 with Z suffix).v1 covers campaigns and metrics. Write endpoints (including campaign creation) are on the roadmap.