Skip to main content
Scrunch API keys authenticate your requests and define which brands and operations your integration can access. Only organization admins can create or manage API keys.
API keys are shown once at creation time. Be sure to copy and store them securely.

​
Where API Keys Live

You can create and manage keys from: Scrunch Dashboard → Organization → Settings → API Keys This panel is available only to organization admins and is also where you manage brands and archival operations.

​
Create an API Key

Complete these steps in your Scrunch UI to provision an API Key ($SCRUNCH_API_TOKEN)
1

Open Organization Settings

Go to Organization → Settings in the left sidebar.
2

Open the API Keys panel

Select API Keys to view existing keys and create new ones.
3

Click "Create API Key"

You’ll be prompted to configure the scope and brand access.
4

Choose the key scope

Scrunch supports several operational scopes:
  • Query (retrieve analytics & metrics)
  • Configure (update brand configuration, prompts, etc.)
  • Create Brand (programmatically create brands)
  • Responses (access raw AI responses; requires approval)
Choose the minimal scope required for your integration.
5

Select brand access

You may scope the key to:
  • Specific brand(s) (recommended for client-facing reporting)
  • All brands (recommended for internal tooling or ETL pipelines)
6

Create and copy the key

Scrunch displays the key once. Copy it immediately and store it securely.

​
Use Your API Key

Include your key as a Bearer token in the Authorization header. 
export SCRUNCH_API_TOKEN="your-key"

curl -H "Authorization: Bearer $SCRUNCH_API_TOKEN" \
  https://api.scrunchai.com/v1/brands
If the key is brand-scoped, calls to other brands will return an authorization error.

​
Best Practices

Use brand-scoped keys

Limit access when integrating with client-facing dashboards or BI tools.

Reserve org-wide keys

Use for internal workflows only (e.g., multi-brand ETL, automation).

Rotate keys periodically

Especially important for deployments or CI environments.

Archive inactive clients

Keeps your organization clean and prevents accidental access.

​
Troubleshooting

If a key cannot access a brand:
  • Verify the key’s scope includes that brand
  • Check that the brand has not been archived