API keys

API keys let your own programs and integrations use the Leadveyor API: send messages, read leads, record outcomes. The same keys connect AI assistants such as Claude, Cursor or VS Code through the MCP server. Only account owners and admins can manage keys.

Creating a key

Click Create key and choose:

  • Name — what the key is for, e.g. "CRM integration". Shown in the list with the date it was last used.
  • Permission — what the key may do (see below).
  • All workspaces of the account — off (default): the key works only in the current workspace, and requests don't need to name it. On: the key works in every workspace, and each request names the workspace in the Leadveyor-Workspace header.
  • Test key — see Test keys.

The key is shown once. Copy it and store it safely, like a password; if it's lost, create a new one.

Permissions

PermissionCan
ReadView leads, messages, contacts, profiles and settings
WriteAlso send messages, record outcomes and change profiles, sources and webhooks
AdminAlso manage API keys and workspaces

Give each integration the lowest permission it needs: a reporting dashboard needs only Read; a CRM that records outcomes needs Write; an AI assistant that only reviews leads needs Read.

Test keys

Messages sent with a test key (lv_test_…) are kept apart from live data: their leads don't appear among your live leads and don't trigger live webhooks. Use test keys while building an integration, then switch to a live key (lv_live_…).

Revoking a key

Revoke disables a key immediately; programs using it stop working at once. Revoke keys you no longer use and any key that may have leaked.

Was this page helpful?