❗ Always check the official sources for detail and current information. The endpoints below change over time. For the complete, up-to-date list of endpoints and fields, use the live Swagger page. For the latest information and the rules that govern all use, see the SwiftFox API Policy page — all API use is governed by the Acceptable Use Policy set out there.
• Swagger (all current endpoints): https://api.ci.swiftfoxcrm.com/swagger/index.html
• API Policy & Acceptable Use Policy: https://www.swiftfoxcrm.com/api-policy
The SwiftFox API lets external tools and websites connect to your SwiftFox environment to read and write data programmatically. It is a REST API (the SwiftFox External API Gateway) that mirrors many of the things you can do in the product itself, so a website, a member portal, or another system can work with your SwiftFox data directly.
This page is a high-level overview of what the API can do. It is not a developer reference — for exact endpoints, request and response shapes, and anything you'd build against, always work from the Swagger page linked above.
Getting access
To use the API you need an API key, created in Settings → Integrations → API keys (see Creating & managing SwiftFox API keys (Document ID: 411)). The key is sent with each request to authenticate it. When you create a key you set what it can reach, so the API only ever exposes what that key is allowed to see. If you need help getting started, contact support@swiftfoxcrm.com.
How a key's scope shapes what the API can do
What any given key can reach is set when you create it, so the capabilities described below are only available to a key that has been granted them. The scope model — the feature areas and access levels, the assigned user whose permissions the key inherits, and the assigned circle — is documented in full in Creating & managing SwiftFox API keys (Document ID: 411).
What you can do with the API (at a high level)
Records — people & organisations
Look up, search, create and update people and organisations, along with their contact details, addresses, custom fields, timeline posts, related data tables, and the memberships that link people to organisations. Reference data (interests, categories, languages, industries, and similar) can also be read. This is the largest part of the API and covers most "sync our website with the CRM" needs.
Forms
Retrieve a form's definition, submit responses to it (with SwiftFox handling validation and any follow-on automations), and calculate form points without submitting. This is the cleanest way to have a website form feed straight into SwiftFox.
Events
Search and list events (including their details, location, custom fields and RSVP options), add people to an event, and update an attendee's RSVP. Useful for publishing events on a website and taking RSVPs.
Financial
Work with the financial records a member portal would need: subscriptions, invoices, receipts, payments, payment methods (cards and direct debits), plans and tax rates. This lets a portal show members what they owe and let them pay or update their payment details.
Segmentation — lists & circles
Read the circles configured in your account and add or remove records from static lists, so a website can filter by segment or push contacts into a list.
Webhooks
Subscribe to receive real-time updates from SwiftFox when something changes, so an external system can stay in sync rather than polling.
What the API does not do
Some things are deliberately outside this API. As a general guide it does not handle file or document upload/download, sending emails or text messages, tasks and calls, reporting or dashboards, or user/login management. If you need one of these, check the Swagger page first and then confirm with the SwiftFox team — don't assume an endpoint exists.
Third-party integrations
SwiftFox also has a Zapier integration, which lets you use the API's capabilities alongside thousands of other apps on the Zapier marketplace without writing code. Search for SwiftFox in the Zapier marketplace.
Usage & fair use
The API is subject to rate limits and usage quotas, and all use must follow the Acceptable Use Policy on the API Policy page. In short: only access data you're authorised to, handle it securely and in line with privacy law, don't attempt to overload or misuse the system, and report any suspected misuse to support@swiftfoxcrm.com. The policy is the authoritative source — review it before building anything against the API.