API

Use cases

The API lets a developer connect another application or internal tool to your workspace. Common small-business uses include:

• bringing new leads into the workspace from a form or another sales tool;
• reading contacts, companies, deals, notes, groups, and views for a report or dashboard;
• updating a record after an external sales event; and
• keeping the workspace as the shared record store while other tools continue to handle outreach or billing.

Getting Started

Before you begin

You need:

• access to the correct workspace;
• permission to create an API key (ask a workspace administrator if the button is unavailable); and
• a safe place to store a secret key and the small program or integration that will use it.

Create a key

1. Open Settings → API Keys.
2. Select Create new secret key.
3. Give the key a clear name, such as Lead form or Weekly report.
4. Copy the key when it appears and save it in a password manager or your integration’s secret store. The complete key is shown only once.
5. Open the linked API documentation from the same page. It explains the available objects, records, notes, groups, views, and request examples.

The page shows a shortened key prefix, creation date, and last-used time after creation. It does not show the complete secret again. If the key is lost, create a replacement.

How to use it

Start with a read-only check

1. Open the generated API documentation and read the Authentication and Quickstart sections.
2. Add the secret to the request exactly as the documentation shows. Direct API requests use the x-api-key authentication header.
3. If the documentation asks for a workspace identifier, provide it using the documented workspace header.
4. Make one read request for a small, known set of records.
5. Check the returned data before enabling a regular sync or any write request.

Add a new lead safely

1. Decide which incoming fields map to the existing object fields.
2. Search for an existing record before creating a new one. This reduces duplicates.
3. Create or update one sample record.
4. Confirm the group, fields, and relationships in the workspace.
5. Only then run the integration for the rest of the leads.

Keep an external process in sync

Use a stable identifier from the external system, search before writing, and record the last successful sync time. Keep write requests small enough that a failed request can be retried without creating duplicates.

Protect and replace a key

Never put a key in browser code, a public repository, a shared document, or a support message. If it may have been exposed:

1. Stop the integration that uses it.
2. Return to Settings → API Keys.
3. Select Revoke for the exposed key and confirm. Revocation cannot be undone.
4. Create a new key and update the integration’s secret store.
5. Test one read request before restoring normal activity.

API access is still limited by the user and workspace permissions behind the key. A key is not a way to grant someone more access.

Troubleshooting

The API documentation or key button is missing

Check that you are in the intended workspace and that your account has the required permission. Ask an administrator if the API feature is not enabled for your workspace.

Authentication fails

Check for a copied space or line break, use the complete key rather than its visible prefix, and confirm that the request uses the documented authentication header. If the key was revoked, create a new one.

The request reaches the API but returns the wrong workspace

Check the workspace identifier and the documented workspace header. Also confirm that the key belongs to the intended workspace.

A field, record, or action is unavailable

Read the endpoint’s permission and object requirements in the API documentation. The account may be able to read a record but not edit it, or the field may not exist in that workspace.

A sync created duplicates

Pause the integration, identify the external identifier and matching field, and change the process to search before create. Clean up duplicates in the workspace only after confirming which record should remain.

A key was lost or exposed

Keys cannot be viewed again. Revoke an exposed key, create a replacement, update the integration, and test it with a small read request.