At a glance
- Availability: Experimental (how to enable).
- Auth: Basic auth.
- Connection: HTTP Basic auth with
CLOSE_API_KEYas the username andCLOSE_API_PASSWORDas the password. - Docs: https://developer.close.com/api/overview/api-key-authentication
Credentials
Set these per environment. See Connect an integration.Setup
- Create a Close account: Sign up at https://www.close.com/ - a 14-day free trial works for testing the API.
- Create an API key: In Close, go to Settings → Developer → API Keys (https://app.close.com/settings/developer/api-keys/) and create a new API key. Keys are scoped to your organization and inherit your user’s permissions.
- Set environment variables: Add CLOSE_API_KEY to your .env. Set CLOSE_API_PASSWORD to an empty string (or leave it unset) - Close uses HTTP Basic auth with the API key as the username and a blank password.
- Verify access: Run the List Leads tool with no query.
- Close recommends API keys (HTTP Basic, key as username, empty password) for server-side integrations; OAuth is reserved for user-facing public apps
- Lead, opportunity, and contact endpoints use trailing slashes (e.g. /api/v1/lead/)
- Monetary values like opportunity value are expressed in cents
Tools
| Tool | Access | Description |
|---|---|---|
| List Leads | Read | List or search leads in Close using the lead query language |
| Get Lead | Read | Get full details of a Close lead, including contacts and opportunities |
| Create Lead | Write | Create a new lead in Close, optionally with contacts |
| Update Lead | Write | Update fields on an existing Close lead |
| List Opportunities | Read | List opportunities, optionally filtered by lead |
| Create Opportunity | Write | Create an opportunity on a Close lead |
| List Contacts | Read | List contacts, optionally filtered by lead |
Example prompts
- List my open opportunities in Close with their values and confidence, grouped by status.
- Create a new lead in Close with a company name, website, and a primary contact.