SAMI OS public API: what you can integrate

If you're building a custom integration or wiring SAMI OS into another system, the public API exposes a stable set of resources you can safely read and write. This guide explains what that surface covers, what stays internal, and how requests authenticate.

What the public API covers

The API is organized into resource families that map to the parts of SAMI OS you already use day to day. External systems can work with:

• Contacts — the core of your CRM, plus contact filters and smart lists for pulling targeted segments.
• Custom fields, tags, and lead sources — the metadata you use to classify and report on contacts.
• Contact relationships — links between people, such as a buyer and their partner.
• Pipeline resources — deals, properties, tasks, notes, appointments, and pipelines, including pipeline stages and moving a deal from one stage to the next.
• SMS and calls — the messaging and voice activity tied to a contact.
• Lead routing — how new leads get assigned across your team.
• API keys — create and manage the credentials that authorize every request.

What stays internal

Not everything in SAMI OS is a public resource. Some routes power the app itself and are intentionally left out of the API so integrations don't depend on internals that can change.

The following areas are not part of the public surface:

• Authentication callbacks and sign-in flows
• Billing and subscription management
• Admin-only and organization-management routes
• Cron jobs, health checks, and debug routes
• Raw provider webhooks (for example, inbound Twilio or email callbacks)
• Generated media uploads and phone-number inventory
• Internal AI workflow helpers that power your SAMI Bots behind the scenes

If a capability isn't listed under the resource families above, treat it as internal and don't build against it.

How to read each resource's docs

Every public API resource documents the same things, so you always know what to send and what to expect back.

1. Create a key

   Generate an API key in Settings → Integrations, under the Zapier / API Keys panel. The key is shown once at creation — copy it then.

2. Authenticate your requests

   Every request authenticates with your API key. The key acts as the user who created it and is limited by the permission scope you chose — Read only, Read & write, or Admin.

3. Check the resource page

   Each resource page covers its authentication, the permissions it requires, the request shape, the response shape, error handling, and rate limits where they apply.

4. Handle errors and limits

   Read the documented error responses and rate limits before you go live, so your integration backs off cleanly instead of hammering the API.

For the full request and response details of any endpoint, open the API docs link at the top of the Zapier / API Keys panel in Settings → Integrations.

Related articles

• Create and manage API keys
• Connect SAMI OS to Zapier
• Integrations in SAMI OS: what connects and where to set it up