Create an API key

Give your integration access to one Acquisity workspace.

An API key is a private credential that lets your tool access Acquisity. For shared integrations and MCP clients that cannot sign in through OAuth, use a workspace API key for CRM MCP access and campaign changes.

Create a workspace key

1. Open the target workspace in Acquisity as an owner or admin.
2. Go to Settings → Workspace API Keys. The page is at /dashboard/{workspace-slug}/settings/api-keys in the app.
3. Click Create key. Enter a Name, choose Expiration, and select the required Scopes (permissions).
4. Click Create key, then use Copy to save the key. The complete key is shown only once.

For your first read-only request, select workspaces:read and campaigns:read. Add permissions only when your integration needs them; see the scope guide.

If the settings page is unavailable, ask your workspace owner to confirm your role and whether Public API access is enabled.

Use your key

Send it in the Authorization header on every request:

Authorization: Bearer <token>

Store keys in your integration's secret storage. Keep them out of browser code, screenshots and shared messages.

Workspace keys and personal tokens

A workspace key belongs to one workspace. Use it for a shared integration, static-key CRM MCP access, or to create, update, launch or pause campaigns.

A personal access token belongs to you. One token can access multiple workspaces where you are a member and Public API access is enabled. Use GET /v1/workspaces to find them, then include the workspace's id in each request. Your token's scopes and your access in that workspace still apply.

A personal token is not an all-workspace MCP or campaign control key. Direct CRM API requests can use a personal token when its scopes and workspace membership allow the operation. For static-key MCP authentication, CRM tools and campaign write operations require a workspace key. OAuth-capable clients can instead use a signed-in, workspace-bound connection. Use a separate workspace key for each workspace where a static integration needs CRM MCP access or campaign changes.

Acquisity staff keys

Acquisity staff can hold a staff key: a personal access token (acq_live_…) that reaches every workspace, so our team can support your account without being added as a member. You can't create one, and nobody can turn an ordinary token into one.

• A staff key works only while its owner still holds an Acquisity staff role. Removing the role stops the key entirely on its next request, including in workspaces where the staff member is still a member.
• In a workspace where the staff member isn't a member, it acts as a member, never an owner or admin, so owner-only and admin-only actions such as renaming or deleting the workspace refuse it. Where the staff member is a member, their own role applies.
• Its scopes apply exactly as for any personal token, and campaign writes still need a workspace key. With the payments read scope, it sees payment details under Acquisity's platform staff policy, whatever its role in the workspace. Payment writes still refuse it.
• Every write it makes is recorded in the workspace audit trail with the staff member's name before it runs. If that record can't be saved, the write is refused with 503 unavailable and nothing changes.
• Each staff member has their own key with an expiry of 90 days or less, and it can be revoked on its own.

Replace or revoke a key

To replace a key, create a new one, update your integration, check a read request, then revoke the old key. To stop access, open its Open key menu, choose Revoke key, and confirm Revoke key.

Keys can be renamed. To change permissions or expiration, create a replacement key.

Next: Make your first request.