API access and reference

REST API access is available by request on Business. It is enabled per workspace after review rather than switched on automatically with purchase.

Good API use cases

Request access when a real workflow needs to:

• upload generated documents automatically;
• publish HTML output from an internal system;
• create personalized Share Links from a CRM or sales workflow;
• find or create companies and contacts;
• retrieve engagement events for an automation or integration.

For a small number of manual uploads, the Document Library is simpler and safer than maintaining an API integration.

For occasional batches, Bulk-generate personalized document links from a CSV or connected Close Smart View. Use the API when link creation needs to run repeatedly inside another system.

Request access

Open Workspace, choose Integrations, and find HummingDeck API. Select Request API access.

The request takes one click. Describing the workflow is optional, and it usually saves a round of email. Useful details:

• the workflow you want to automate;
• expected upload or request volume;
• the file types involved;
• whether you need companies, contacts, shares, views, or events.

Workspace owners and admins can send the request. We reply by email when access is switched on.

On plans below Business the section stays visible and locked, and opens your plan options instead.

Create the workspace token

After access is switched on, the workspace owner returns to Workspace, Integrations, HummingDeck API. Creating the token is owner-only, even though admins can request access.

The token is shown once. Store it in a secret manager. Do not paste it into browser code, an HTML upload, a public repository, a shared document, or a support ticket.

Creating a new token replaces the previous token immediately. Switching a token off is permanent for that token. Workspace tokens expire after one year.

Open the technical API reference

Use this Support article for access, credential, and workflow guidance. Use the canonical HummingDeck API reference for current endpoints, authentication, request and response schemas, errors, document uploads, Share Links, companies, contacts, views, events, and webhooks.

Browser uploads accept files up to 100 MB. The API document upload endpoint has a 30 MB limit. HTML uploaded through the API must still meet the same static-content and asset requirements as a manual upload.