API Quickstart

Make your first MentionFox API call in under 5 minutes. This guide covers authentication, the base URL, and the most common endpoints.

Step 1: Get Your API Key

1. Go to Settings > API Keys in MentionFox.
2. Click Generate API Key.
3. Copy the key immediately -- it is shown only once. Store it securely (e.g., in an environment variable, never in client-side code).

Step 2: Base URL & Authentication

All API requests go through foxapis.com, the unified API gateway for MentionFox and other Fox products.

Base URL: https://api.foxapis.com/v1/mentionfox

Authentication: Bearer token in the Authorization header
Authorization: Bearer YOUR_API_KEY

Step 3: Your First Request

Fetch recent mentions for a client:

GET /v1/mentionfox/mentions?client_id=CLIENT_ID&limit=20

Headers:
  Authorization: Bearer YOUR_API_KEY
  Content-Type: application/json

Response (abbreviated):

{
  "data": [
    {
      "id": "mention_abc123",
      "platform": "reddit",
      "title": "Has anyone tried MentionFox?",
      "url": "https://reddit.com/r/saas/...",
      "sentiment": "positive",
      "created_at": "2026-04-01T10:30:00Z"
    }
  ],
  "total": 142,
  "page": 1,
  "per_page": 20
}

Core Endpoints

Mentions

• GET /mentions -- List mentions (filter by client, platform, sentiment, date range)
• GET /mentions/:id -- Get a single mention with thread leads

Clients (Brands)

• GET /clients -- List all monitored clients
• GET /clients/:id -- Client details including enrichment data
• POST /clients -- Create a new client (Enterprise only)

Contacts & Dossiers

• GET /contacts -- List contacts (filter by client)
• GET /contacts/:id -- Full contact record with dossier data
• POST /contacts/:id/enrich -- Trigger enrichment (light or deep mode)

Scans

• GET /scans -- List scan records
• POST /scans -- Trigger a new scan run (Enterprise only)
• GET /scans/:id/results -- Scan results and mentions found

Dealflow

• GET /dealflow -- List pipeline leads
• PATCH /dealflow/:id -- Update lead stage or notes

Rate Limits

API requests are rate-limited per plan:

• Agency: 100 requests/minute
• Enterprise: 1,000 requests/minute

Rate limit headers are included in every response: X-RateLimit-Remaining and X-RateLimit-Reset.

Error Handling

The API returns standard HTTP status codes. Error responses include a JSON body:

{
  "error": "insufficient_credits",
  "message": "Not enough credits to perform this action",
  "credits_required": 50,
  "credits_remaining": 12
}

Common codes: 401 (invalid key), 403 (plan doesn't include API), 429 (rate limited), 402 (insufficient credits).