Skip to Content

API reference / Get started

Authentication and permissions

Use scoped API keys for REST integrations and OAuth for MCP.

InterfaceAuthenticationWhere to start
REST: /api/v1/*Vendita API key in the Bearer headerAPI quick start
MCP: /api/mcpOAuth sign-in and user approvalMCP quick start

The OpenAPI document is public. Protected REST operations require a key.

Authorization: Bearer vk_live_YOUR_KEY

vk_live_YOUR_KEY is a placeholder. Keep real keys in server-side configuration or a secrets manager; do not embed them in browser code, a public repository, or a support message.

Keys belong to one workspace

A key delegates the creator’s access in its workspace. Effective access is the intersection of the scopes selected for the key and the creator’s current membership permissions. Revoked or expired keys, removed creators, and keys whose creators no longer belong to the workspace cannot authenticate.

Use GET /me to inspect the effective workspace, role, and scopes. The scope name describes the required capability; an operation’s plan checks can still block it.

Common taskPermission
List agentsagents:read
Create or edit an agentagents:write
Edit Sales Brain knowledgeknowledge:write
Read contactscontacts:read
Import contactscontacts:write
Create or edit a campaigncampaigns:write
Preview or confirm launchcampaigns:launch
Read analyticsanalytics:read
Read billing and usagebilling:read
Change billingbilling:write

Do not infer that every scope has a public endpoint. The endpoint reference defines the supported API surface. API keys cannot create or manage other API keys.

Rotate a key

  1. Create a replacement in Settings → API keys.
  2. Update your integration and verify it with GET /me.
  3. Select Revoke beside the old key and confirm Revoke key.

If a key is exposed, revoke it and replace it. Copying a newly created key is the only opportunity to retrieve its full value.

On this page