Developer Portal

​

1. Get an API key

1. Open the Salesfinity dashboard and go to Settings → Connections & API.
2. Generate a new API key.
3. Copy it immediately and store it in your secret manager. Treat it like a password.

​

2. Make your first call

curl https://client-api.salesfinity.co/v1/team \
  --header 'x-api-key: YOUR_API_KEY'

const res = await fetch("https://client-api.salesfinity.co/v1/team", {
  headers: { "x-api-key": process.env.SALESFINITY_API_KEY },
});

if (!res.ok) {
  // Errors are always JSON, never an HTML page.
  const { message, error, statusCode } = await res.json();
  throw new Error(`Salesfinity ${statusCode} ${error}: ${message}`);
}

const team = await res.json();

import os, requests

res = requests.get(
    "https://client-api.salesfinity.co/v1/team",
    headers={"x-api-key": os.environ["SALESFINITY_API_KEY"]},
    timeout=30,
)

if not res.ok:
    body = res.json()
    raise RuntimeError(
        f"Salesfinity {body['statusCode']} {body['error']}: {body['message']}"
    )

team = res.json()

{ "message": "Forbidden resource", "error": "Forbidden", "statusCode": 403 }

​

3. Build the client

​

Generate a client from the OpenAPI description

# TypeScript, using openapi-typescript
npx openapi-typescript https://docs.salesfinity.ai/openapi.json -o salesfinity.d.ts

# Any language, using openapi-generator
openapi-generator-cli generate \
  -i https://docs.salesfinity.ai/openapi.json \
  -g python \
  -o ./salesfinity-client

​

Conventions worth encoding once

​

Retries

​

4. Test safely

• Start read-only. GET /v1/team, GET /v1/dispositions, GET /v1/custom-fields, and the analytics endpoints have no side effects and are safe to hammer during development.
• Use a dedicated test team. Generate a key for a team that is not actively dialing, so writes cannot disturb a live queue.
• Use a throwaway contact list. Create a List gives you an isolated target for add, remove, and merge calls that you can delete afterwards.
• Know which writes reach the dialer. Add a Contact to a List puts the contact into the dialing queue immediately, and Reimport Contacts pushes a whole list into it. Everything else is safe to exercise against a test list.
• Point the enrichment callback_url somewhere disposable while developing, so test results are not POSTed at a production handler.

​

5. Pick an integration surface

​

Machine-readable resources

curl -H 'Accept: text/markdown' https://docs.salesfinity.ai/developers
curl https://docs.salesfinity.ai/developers.md

​

Support

• Email — [email protected]
• Help center — support.salesfinity.ai