Public API (v1)

The SoConnective public API lets you read and write your account data programmatically. It is a clean REST API over HTTPS that returns JSON. Every request is authenticated with an account API key and is strictly scoped to that account.

Base URL

https://crm.soconnective.com/api/v1

Authentication

Create an API key under Settings -> API (account admins only). The key is shown once at creation -- store it securely. Send it as a Bearer token:

Authorization: Bearer fos_live_xxxxxxxxxxxxxxxx

Keys are account-scoped: a key can only ever read or write the data of the account that created it. Revoke a key any time from Settings -> API.

Conventions

• All responses are JSON. Successful reads return { "data": [...], "page": 1, "total": N }; writes return { "data": { ... } }.
• Errors return { "error": "..." } with an appropriate status code: 401 (missing/invalid key), 403 (missing scope), 429 (rate limited, with a Retry-After header), 400 (bad input).
• Rate limit: 120 requests per minute per key.
• Scopes: keys carry read and write scopes (GET requires read, POST requires write).

Endpoints

Contacts

GET  /api/v1/contacts?limit=50&page=1
POST /api/v1/contacts        { "fullName": "Jane Doe", "email": "jane@acme.com", "phone": "..." }

Deals

GET  /api/v1/deals?limit=50&page=1
POST /api/v1/deals           { "name": "Acme - Website", "value": 5000, "stage": "New", "pipeline": "Sales" }

Example

curl https://crm.soconnective.com/api/v1/contacts \
  -H "Authorization: Bearer fos_live_xxxxxxxxxxxxxxxx"

curl -X POST https://crm.soconnective.com/api/v1/contacts \
  -H "Authorization: Bearer fos_live_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d `{"fullName":"Jane Doe","email":"jane@acme.com"}`

The API never exposes data outside your account, and the tenant of any record you create is set automatically from your key -- it cannot be overridden.