Skip to content
Submit a Support Ticket
  • There are no suggestions because the search field is empty.

How do I use the Sophiie API?

The Sophiie API gives your developer REST endpoints for reading and writing your Sophiie data — leads, appointments, inquiries, services, products, FAQs, scenarios and more. Get an API token at Settings → Workspace → API token and point requests at https://api.sophiie.ai.

Steps

  1. In your Sophiie dashboard, go to Settings → Workspace → API token and create your token.
  2. Send it as a Bearer token on every request — every documented endpoint requires it:

`` Authorization: Bearer <YOUR_ACCESS_TOKEN> ``

  1. Use the base URL https://api.sophiie.ai (development: https://api.dev.sophiie.ai).
  2. Hand your developer the complete OpenAPI specification: https://api.sophiie.ai/openapi — it documents every endpoint, parameter and response.

Use of the API is covered by the Developer API Terms on our docs site — worth a read before you build.

What you can work with

  • Leads — list, get, create, update, delete, plus notes and activities.
  • Appointments — appointment data including attendees, schedule and lead information.
  • Inquiries — list, get and archive.
  • Companies — notes.
  • Organisation and members — organisation details, availability, members, services and products.
  • Setup resources — FAQs, products and services (both with batch endpoints), scenarios and transfers.
  • Outbound messaging — send an SMS or place a call.
  • Agent tasks — start, get, list, cancel and respond to tasks, plus their artifacts and capabilities.

Two things worth knowing before your developer starts:

  • Listing products and services is done at /v1/organization/products and /v1/organization/services — there is no GET /v1/products or GET /v1/services.
  • The /v1/policies endpoints are still served for integrations built before the Policies feature was retired, and shouldn't be used for new work.

HTTP methods

The API follows REST conventions:

  • GET retrieves data, with query parameters for filtering where supported:

`` curl "https://api.sophiie.ai/v1/leads" \ -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" ``

  • POST creates new resources, with application/json in the request body:

`` curl -X POST "https://api.sophiie.ai/v1/leads" \ -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \ -H "Content-Type: application/json" \ -d '{"name": "John Doe", "email": "john@example.com"}' ``

  • PUT and PATCH update existing resources — for example a lead, a service, a product, a scenario, a transfer or an FAQ. See the OpenAPI spec for each endpoint's method.
  • DELETE removes resources:

`` curl -X DELETE "https://api.sophiie.ai/v1/leads/{id}" \ -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" ``

Limits

  • 60 requests per minute per API key. This is fixed for everyone and can't be raised. Going over returns a 429 response with a Retry-After header telling you when to try again.
  • 1 MB maximum request body.
  • Agent tasks: at most 10 task starts per organisation per minute.

Responses and errors

All responses are JSON. Errors follow this structure — for example, a bad or missing token:

`` { "success": false, "message": "Invalid or expired token", "error": { "status": 401, "message": "Invalid or expired token" } } ``

Agent-task endpoints use a slightly richer envelope that adds a machine-readable code field inside error.

Common Questions

Can I get a higher rate limit?

No. The limit is a fixed 60 requests per minute per API key for every customer and can't be raised — build retry handling around the 429 / Retry-After response instead.

Where are the webhook endpoints?

Not on this API. Webhook subscribe and unsubscribe belong to the separate Sophiie Zapier Webhook API at https://webhooks.sophiie.ai (development: https://webhooks.dev.sophiie.ai), which has its own reference section and uses Zapier's OAuth rather than your API token — don't confuse the two. If you just want Sophiie events pushed to your other apps, use the Zapier integration rather than calling that API directly.

Is the API read-only?

No. Alongside reads, it can create, update and delete across the resources listed above — including leads (your customers), services, products, scenarios, FAQs and transfers — and send an SMS or place a call.

Where's the full endpoint reference?

https://api.sophiie.ai/openapi — the complete OpenAPI specification, served from the API itself.

Need More Help?

If you're stuck getting your first API call working, ask Sophiie Assistant in your dashboard first — she can guide you or make the change for you. Still stuck? Email support@sophiie.ai or call +61 7 5620 4640.