Close

{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}

At a glance

  • Availability: Experimental (how to enable).
  • Authentication: Basic auth.
  • Connection: HTTP Basic auth with CLOSE_API_KEY as the username and CLOSE_API_PASSWORD as the password.
  • Provider documentation: Authentication reference.

Credentials

Set these per environment. See Connect an integration.

VariableRequiredDescription
CLOSE_API_KEYYesClose API key (used as the HTTP Basic username) Docs.
CLOSE_API_PASSWORDNoHTTP Basic password for Close - always leave this set to an empty string; Close authenticates with the API key as username and a blank password Docs.

Setup

  1. Create a Close account: Sign up at https://www.close.com/ - a 14-day free trial works for testing the API.
  2. 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.
  3. 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.
  4. Verify access: Run the List Leads tool with no query.

Provider notes

  • 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

Provider API reference.

Tools

ToolAccessDescription
List Leads<br /><code className="reference-identifier">close__list_leads</code>ReadList leads
Get Lead<br /><code className="reference-identifier">close__get_lead</code>ReadGet lead
Create Lead<br /><code className="reference-identifier">close__create_lead</code>WriteCreate lead
Update Lead<br /><code className="reference-identifier">close__update_lead</code>WriteUpdate lead
List Opportunities<br /><code className="reference-identifier">close__list_opportunities</code>ReadList opportunities
Create Opportunity<br /><code className="reference-identifier">close__create_opportunity</code>WriteCreate opportunity
List Contacts<br /><code className="reference-identifier">close__list_contacts</code>ReadList contacts

Verify the connection

Call a read tool such as close__list_leads with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.