Verify connectivity and authentication

GET

ping

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

{
  "data": {
    "status": "ok"
  },
  "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) enforced by the backend.

Response

Authenticated and reachable

data

object

required

Show child attributes

meta

object

required

Show child attributes

List campaignsReturns all campaigns for the authenticated organization. Intended for reporting and data warehouse sync.

Verify connectivity and authentication

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

{
  "data": {
    "status": "ok"
  },
  "meta": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}