canonical: https://jentic.com/apis/swiftfoxcrm.com/swiftfoxcrm

# Swiftfoxcrm SwiftFox External API Gateway

SwiftFox CRM API for managing circles, contacts, events, financial operations, organizations, people, and webhooks. The API exposes 24 endpoints secured with bearer authentication.

## For AI agents

Programmatically get current user, list circles. Covers 24 operations with bearer authentication.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- Get current user
- List circles
- Create contact
- Update contact
- Delete contact

## Use cases

### CRM Operations

Use the SwiftFox External API Gateway to perform crm operations programmatically. The API provides 24 endpoints covering core functionality including get current user, list circles, create contact.

Example prompt: Call GET /me to get current user

### Automated Circles Management

Automate circles operations by combining multiple SwiftFox External API Gateway endpoints. Agents can list circles and then create contact in a single workflow.

Example prompt: Call GET /circles to list circles, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SwiftFox External API Gateway endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually.

Example prompt: Search Jentic for 'get current user', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/me` | Get current user |
| GET | `/circles` | List circles |
| POST | `/contacts` | Create contact |
| GET | `/contacts` | List contacts |
| GET | `/contacts/{id}` | Get contact |
| PUT | `/contacts/{id}` | Update contact |
| DELETE | `/contacts/{id}` | Delete contact |
| POST | `/events` | Create event |

## Key resources

- **Circles** — Operations related to Circles
- **Contacts** — Operations related to Contacts
- **Events** — Operations related to Events
- **Financial** — Operations related to Financial
- **Organizations** — Operations related to Organizations

## Why Jentic

- **Setup:** Wiring the SwiftFox External API Gateway by hand means learning its bearer token scheme, pointing at the api.ci.swiftfoxcrm.com host, and writing the request and error handling for its CRM operations yourself. Through Jentic you install once, import SwiftFox from the API Directory, store the bearer token once, and your agent calls it.
- **Permission scoping:** SwiftFox puts the contact id in the URL path (`/contacts/{id}`), so a rule can pin your agent to one contact: it can read and update that record and nothing else. You choose the operations it may call, so destructive ones like deleting a contact are not included unless you add them.
- **Credential handling:** Your SwiftFox bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a contact' or 'get the current user', and Jentic returns the matching SwiftFox operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the SwiftFox External API Gateway use?

The SwiftFox External API Gateway uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I get current user with the SwiftFox External API Gateway?

Yes. Use the GET /me endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the SwiftFox External API Gateway?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I get current user through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get current user'. Jentic returns the matching SwiftFox External API Gateway operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the SwiftFox External API Gateway have?

The SwiftFox External API Gateway exposes 24 endpoints covering circles, contacts, events operations.

### Can I limit what my agent is allowed to do with the SwiftFox External API Gateway?

Yes. Because Jentic One is self-hosted, you write the rules that decide which SwiftFox operations and credentials your agent can use. Since SwiftFox puts the contact id in the URL path (`/contacts/{id}`), a rule can pin the agent to a single contact so it can read (GET `/contacts/{id}`) and update (PUT `/contacts/{id}`) that one record and nothing else. You choose the operations it may call, so destructive ones like DELETE `/contacts/{id}` are excluded unless you explicitly add them.