Obtaining an API Key
Generate an API key to authenticate and scope access to the ClosingDealz API.
Table of Contents
Obtaining an API Key
To use the ClosingDealz API, you must first generate an API key for the workspace you want to integrate with.
API keys are managed directly inside the ClosingDealz application and are tied to a specific workspace.
Where to Create an API Key
- Log in to your ClosingDealz account
- Select the Organization and Workspace you want to use
- Navigate to Workspace Settings
- Open the API / Developer section
- Generate a new API key
Once created, the API key will be shown only once. Make sure to copy and store it securely.
Workspace Scope
Each API key belongs to exactly one workspace.
- Leads created via the API will appear only in that workspace
- If you manage multiple businesses or client projects, create a separate API key per workspace
- Switching workspaces requires switching API keys
This design keeps data isolated and predictable across organizations and clients.
Key Management Guidelines
- Treat API keys like passwords
- Do not share keys between clients or environments
- Use separate keys for production and testing
- Revoke and regenerate keys immediately if compromised
Next Steps
After obtaining your API key, include it in every request using the X-API-Key header.
Continue to the next section to learn how authentication works in detail.