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 campaign changes, use a workspace API key.
Create a workspace key
- Open the target workspace in Acquisity as an owner or admin.
- Go to Settings → Workspace API Keys. The page is at
/dashboard/{workspace-slug}/settings/api-keysin the app. - Click Create key. Enter a Name, choose Expiration, and select the required Scopes (permissions).
- 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 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 campaign control key. Campaign write operations currently require a workspace key, even when your personal token has campaigns:write. Use a separate workspace key for each workspace where an integration needs to change campaigns.
| Credential | Access |
|---|---|
Workspace API key (acq_org_…) | One workspace. Required for campaign write operations. |
Personal access token (acq_live_…) | Workspaces where its user is an active member and Public API access is enabled. Does not satisfy the workspace-key requirement for campaign writes. |
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.