Quickstart

Get up and running with the GhostFlow API in minutes.

Prerequisites

• A GhostFlow account (sign up)
• An active subscription (Free tier works for testing)

Steps

1. Generate an API key

   Go to Settings → API Keys in your dashboard and click Create API Key. Give it a name and select the permissions you need.

   Save the returned key (starts with gf_). You won’t see it again.

2. Find your Team ID

   In the dashboard, open DevTools (F12) → Network tab → reload the page → click any API request → find the x-team-id value in Request Headers. See Authentication for details.

3. Make your first API call

   Every request needs both your API key and your Team ID:

   cURL

   curl https://devcore.getghostflow.io/api/v1/campaigns \
     -H "Authorization: Bearer gf_your_api_key_here" \
     -H "X-Team-Id: your-team-uuid-here"

   TypeScript

   const response = await fetch('https://devcore.getghostflow.io/api/v1/campaigns', {
     headers: {
       'Authorization': 'Bearer gf_your_api_key_here',
       'X-Team-Id': 'your-team-uuid-here',
     }
   });
   const campaigns = await response.json();
   console.log(campaigns);

   Python

   import requests
   
   response = requests.get(
       'https://devcore.getghostflow.io/api/v1/campaigns',
       headers={
           'Authorization': 'Bearer gf_your_api_key_here',
           'X-Team-Id': 'your-team-uuid-here',
       }
   )
   campaigns = response.json()
   print(campaigns)

   Caution

   Missing the X-Team-Id header? You’ll get {"code": "MISSING_TEAM_CONTEXT"}. See why this is required.

4. Check the response

   You’ll get a JSON array of your campaigns:

   [
     {
       "id": "550e8400-e29b-41d4-a716-446655440000",
       "name": "My Campaign",
       "status": "active",
       "created_at": "2025-01-15T10:30:00Z"
     }
   ]

Next steps

• Authentication deep dive — Learn about scopes and key management
• Rate limits — Understand API limits per plan
• API Reference — Explore all available endpoints