company logo

Salesforge Helpdesk

Go to Salesforge
Agent FrankLeadsforge - Search Engine For LeadsPrimeforge - Google & MS365Mailforge - Distributed Email InfrastructureInfraforge - Private Email InfrastructureWarmforge - Email Deliverability Center
All collectionsAPI & DevelopersWorkspace-level API keys in Salesforge

Workspace-level API keys in Salesforge

Learn what a workspace-level API key can access, how it differs from an account-wide key, and how to create one.

You can now create API keys that only work in one workspace, right from the Salesforge dashboard. This makes it safer to give API access to a client, a contractor, or a third-party tool, because the key cannot reach anything outside that workspace.

What a workspace key can do

A workspace key has full access to the workspace it was created in. It can make all types of API requests there, including GET and POST, so it can read, create, update, and delete data. This includes:

  • Sequences, including their steps, schedules, contacts, and mailbox assignments

  • Contacts, including bulk actions and the DNC list

  • Mailboxes, threads, and replies

  • Webhooks

  • Products and knowledge bases

  • Integration endpoints such as RB2B, Make.com, and data enrichment

Some of the integration endpoints work only with a workspace key. An account-wide key is not accepted for them.

What a workspace key cannot do

  • It cannot access any other workspace in your account. A request for another workspace returns a “not found” response.

  • It cannot create a new workspace.

  • When it lists workspaces, it only returns the workspace it belongs to.

Workspace key vs account-wide key

Workspace key

Account-wide key

Access inside a workspace

Full access

Full access

Workspaces it can reach

Only the one it was created in

All workspaces in your account

If the key is leaked

Only that workspace is exposed

Every workspace is exposed

Creating new workspaces

Not allowed

Allowed

When to use each type

Use a workspace key when:

  • You are giving API access to a client, contractor, or partner who should only see their own workspace.

  • You are connecting a third-party tool or integration to one workspace.

  • You want to limit the damage if a key is leaked or a tool misbehaves.

Use an account-wide key when:

  • You manage several workspaces from one script or tool.

  • You need to create new workspaces through the API.

  • The key is only used internally by your own team.

Create a workspace-level API key

  1. Log in to your Salesforge account and switch to the workspace you want the key to work in.

  2. Go to Settings.

  3. Open the API & MCP tab.

  4. Click Add new key.

Salesforge Settings screen with the API & MCP tab selected, showing no API keys and arrows pointing to Add new key buttons. Visible: Settings, API & MCP, API, Connect Salesforge with your apps and tools, API Docs, Add new key.

  1. In the Add new API key pop-up, enter a descriptive name in API key name. This field is required.

  2. Keep Limit this key to the current workspace ticked.

  3. Click Generate API key.

Add new API key dialog with a name field, checked workspace limit option, and Discard and Generate API key buttons. Visible: Add new API key, API key name, Enter descriptive name, Limit this key to the current workspace, Discard, Generate API key.

To create a key that works across your whole account, untick Limit this key to the current workspace before you click Generate API key.

Good to know

  • A workspace key is tied to the workspace you are in when you create it, so select the right workspace first.

  • Because a workspace key has full access in its workspace, treat it like a password and share it only with people and tools you trust.

  • Use a clear name for each key, such as the client or tool it is for, so you can tell your keys apart later.

Need help?

If you have any questions about API keys, reach out to our support team through the chat widget and we will be happy to help.

Did this answer your question?
😞
😐
😁