Authentication

Every request to the ScoutLayer API must include a valid API key. You can pass it in one of two ways:

Option 1 — X-API-Key header (recommended)

X-API-Key: YOUR_API_KEY

curl https://api.scoutlayer.io/v1/shopify/apps/klaviyo \
  -H "X-API-Key: YOUR_API_KEY"

const res = await fetch(
  "https://api.scoutlayer.io/v1/shopify/apps/klaviyo",
  { headers: { "X-API-Key": "YOUR_API_KEY" } }
);

import httpx

res = httpx.get(
    "https://api.scoutlayer.io/v1/shopify/apps/klaviyo",
    headers={"X-API-Key": "YOUR_API_KEY"},
)

Authorization: Bearer YOUR_API_KEY

curl https://api.scoutlayer.io/v1/shopify/apps/klaviyo \
  -H "Authorization: Bearer YOUR_API_KEY"

const res = await fetch(
  "https://api.scoutlayer.io/v1/shopify/apps/klaviyo",
  { headers: { "Authorization": "Bearer YOUR_API_KEY" } }
);

import httpx

res = httpx.get(
    "https://api.scoutlayer.io/v1/shopify/apps/klaviyo",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)

Open the dashboard.
Click New API key, give it a name, and copy the key immediately — it won’t be shown again.

Keep your API key secret. Never commit it to source control or expose it in client-side code. Use environment variables or a secrets manager.

Status	Meaning
`401 Unauthorized`	Missing or invalid API key.
`402 Payment Required`	Valid key, but your credit balance is zero. Top up in the dashboard.

⌘I