API Keys Documentation v2.7.3
Obtaining an API Key
To obtain an API key, please contact your Account Manager. They will assist you in setting up the appropriate access for your needs.
API Key Scope
Each API key is scoped to a single Project. If you need to interact with multiple projects programmatically, you will need one API key per project.
API Key Format
API keys are generated in UUID format. This ensures uniqueness and security across all integrations.
The UUID format is a 128-bit number represented as a string in the form of 8-4-4-4-12, where each group of numbers is separated by a hyphen.
For example:
123e4567-e89b-12d3-a456-426614174000
Using Your API Key
Your API key should be used in the URL path where :id is specified in our routes. For example:
POST /api/{your-api-key}/create-lead
GET /api/{your-api-key}/me