Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.openfunnel.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

Use the Agent Auth section in this docs site to get your credentials first:
  • POST /api/v1/agent/sign-up
  • POST /api/v1/agent/verify
After verification, call the event discovery endpoints with: 
Authorization: Bearer YOUR_API_KEY
These endpoints use user-scoped API keys. You do not need to send X-User-ID.

​
Base path

All event discovery endpoints live under: 
/api/v1

​
How To Use This Section

The event discovery API is organized into three functional groups:
  • Events Browse verticals and event types.
  • Accounts Find accounts, search accounts with events, and fetch account-level event detail.
  • People Find people and fetch person-level event detail.
Use the left sidebar to navigate directly to the group you need. Most users will follow this sequence:
  1. Start in Events to list verticals and inspect event types.
  2. Move to Accounts to find companies or search companies with recent event activity.
  3. Use People when you want contacts associated with a vertical or specific activity.

​
Common Response Shapes

List endpoints return: 
{
  "data": [],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total_count": 0,
    "has_more": false
  }
}
The composite account detail endpoint returns: 
{
  "data": {
    "account": {},
    "people": [],
    "events": []
  }
}

​
Notes

  • These endpoints are read-only.
  • All endpoints are rate limited.
  • Repeated filters should be sent as repeated query params, for example country=US&country=CA.
  • List endpoints are intentionally slim for speed; the account detail endpoint is the richer, bounded view.