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 & DevelopersSalesforge API

Salesforge API

Salesforge API access, API keys, authentication, and how the same API and webhooks apply to Agent Frank.

The Salesforge API lets you work with your Salesforge workspace programmatically, for custom integrations, automation, and data sync between Salesforge and your other tools. Agent Frank is part of Salesforge, so the same API and webhooks apply to it.

Key facts

  • The Salesforge API is available on the Growth plan. An Agent Frank subscription gives you the same access as the Growth plan, including the API.

  • Send the raw API key in the Authorization header, with no "Bearer " prefix.

  • Agent Frank has no separate API or webhooks. Use the Salesforge API and Salesforge webhooks.

  • No rate limit is currently enforced on the Salesforge public API.

  • The full reference is in the developer documentation at developer.salesforge.ai.

Which plan includes the Salesforge API?

The Salesforge API is available on the Growth plan. An Agent Frank subscription gives you the same access as the Growth plan, including the API. If you're on the Pro plan without Agent Frank, you'll need to upgrade to use the API. See the Salesforge pricing page for current plans.

Does Agent Frank have an API or webhooks?

No. Agent Frank doesn't have a separate API or separate webhooks. Agent Frank is part of Salesforge, so everything goes through the Salesforge public API and Salesforge webhooks described in this article and in the Webhooks article.

There is no Agent Frank-specific API documentation. The Salesforge docs are the ones to use.

How do I connect Agent Frank to a custom CRM?

Use Salesforge webhooks to get notified about replies and booked meetings, and use the Salesforge API to read and update contacts, sequences, and conversations. Booked and completed meetings arrive as label_changed events, which is explained in the Webhooks article.

How do I find Agent Frank's sequences and conversations in the API?

Sequence responses include an agentId field, and you can filter threads by agent with the agent_ids[] parameter. Webhook events don't include an agentId. See the developer documentation for the exact request and response format.

How do I get an API key?

  1. Log in to Salesforge.

  2. Go to Settings.

  3. Open the API & MCP tab.

  4. Click Add new key, enter a name, and click Generate API key.

Store your API key securely, as it grants access to your Salesforge data. Use a separate key for each integration, rotate keys regularly, and never share a key in tickets, chat, or screenshots.

Should I use a workspace-limited key or an account-wide key?

By default a key is limited to the workspace you created it in, and it can't see anything else. To create a key that works across your whole account, untick "Limit this key to the current workspace" before generating it.

Use a workspace-limited key for a client or contractor, so they only get access to their own workspace. Use an account-wide key only for your own integrations that need to work across workspaces. For the differences between the two types, see Workspace-level API keys in Salesforge.

How do I authenticate API requests?

All API requests require your API key. Send the raw API key in the Authorization header of each request, with no prefix:

Authorization: YOUR_API_KEY

Do not add "Bearer " before the key. Adding it changes the header value and Salesforge API requests will fail. The Multichannel endpoints also accept an optional "Bearer " prefix, but the raw key works with both the Salesforge and Multichannel endpoints, so it is the format to use.

Example request:

curl -sS "https://api.salesforge.ai/public/v2/workspaces" \
  -H "Authorization: YOUR_API_KEY"

If a request fails, check the response status:

  • 401: the API key is missing or invalid. Check that you are sending the raw key, with no "Bearer " prefix and no extra spaces.

  • 403: the key is valid but does not have access to the requested resource, for example a workspace-limited key used on another workspace.

How do I check that my API key is valid?

Send a request to GET /me. If the key is valid, you get a 200 response with your account ID and the key name. If the key is invalid, you get a 401.

curl -sS "https://api.salesforge.ai/public/v2/me" \
  -H "Authorization: YOUR_API_KEY"

Is there a rate limit on the Salesforge API?

No rate limit is currently enforced on the Salesforge public API or the Multichannel API. These limits may change as the APIs evolve. For the limits on other Forge products, see Forge API & MCP: Rate Limits, Authentication & Known Gaps.

Where is the API documentation?

  • Developer documentation: endpoints, request formats, response schemas, and authentication.

  • Swagger documentation: explore the endpoints and test requests directly.

  • Webhooks article: event types, filters, and the payload for each event.

  • Verify webhook signatures: how to check that a webhook delivery really came from Salesforge.

What can I do with the Salesforge API?

The Salesforge API provides access to many core platform features, including:

Workspaces

  • Create and retrieve workspaces

  • Access workspace information

Contacts

  • Create contacts

  • Bulk import contacts

  • Retrieve contact records

Sequences and multichannel sequences

  • Create, update, and delete sequences

  • Assign contacts to sequences

  • Manage sequence schedules

  • Update sequence status

  • Retrieve sequence analytics and performance data

  • Manage multichannel sequences

  • Connect LinkedIn accounts

  • Configure sender profiles

  • Manage enrollments and sequence actions

  • Retrieve validation results

Mailboxes

  • Retrieve mailbox information

  • Update mailbox settings

Threads and conversations

  • Retrieve email threads

  • Manage thread labels

  • Reply to email conversations

  • Access conversation data

Products

  • Create and manage products

  • Retrieve product information

Webhooks

  • Create webhooks

  • Receive real-time notifications when supported events occur

Related articles

  • Webhooks

  • Workspace-level API keys in Salesforge

  • How to Create an API Key in any forge products

  • Forge API & MCP: Rate Limits, Authentication & Known Gaps

Need help?

If you have questions about using the Salesforge API or run into issues while building an integration, contact us via the live chat in the bottom right corner.

Did this answer your question?
😞
😐
😁