Authentication

​

Overview

​

Creating an API Key

1. In your project, go to Settings → API
2. Click Create API key
3. Name the key, pick its Projects and its Access (read and write, or read-only)
4. Click Create API key and confirm it’s you with your passkey, authenticator code or a recovery code
5. Copy the key from the Copy your new key window. It is shown only once

​

Using Your API Key

curl https://app.elasticfunnels.io/api/brands/{brand_id}/pages/all \
  -H "EF-Access-Key: your_api_key_here"

const headers = {
  'EF-Access-Key': 'your_api_key_here',
  'Content-Type': 'application/json'
};

const response = await fetch('https://app.elasticfunnels.io/api/brands/{brand_id}/pages/all', {
  headers: headers
});

import requests

headers = {
    'EF-Access-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

response = requests.get(
    'https://app.elasticfunnels.io/api/brands/{brand_id}/pages/all',
    headers=headers
)

<?php

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://app.elasticfunnels.io/api/brands/' . $brandId . '/pages/all');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'EF-Access-Key: your_api_key_here',
    'Content-Type: application/json'
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);

​

Authentication Errors

​

Invalid API Key

{
  "message": "Invalid API key"
}

​

No Brand Access

{
  "message": "Invalid API key or brand access denied"
}

• Your API key is valid but doesn’t have access to the specified brand/project
• You’re trying to access a project you’re not a member of

​

Missing API Key

​

API Key Scope and Permissions

• User-specific: Each key is tied to your user account
• Project-scoped: Each key reaches only the projects you picked (one, several, or all projects you can access)
• Read-only or read and write: chosen when you create the key
• Permission-aware: Within those projects, requests never go beyond your own role (Owner, Admin, Editor, etc.)

​

Example Permission Scenarios

​

Best Practices

​

Regenerating Your API Key

1. Go to Settings → API
2. Click Revoke on the key (it stops working at once), then create a new one. For a legacy full-access key, click Regenerate instead
3. Confirm it’s you when asked
4. Update all integrations with the new key

​

Testing Your Authentication

curl https://app.elasticfunnels.io/api/brands/{brand_id} \
  -H "EF-Access-Key: your_api_key_here"