Skip to main content
The Main API is the primary way to integrate Spotzee with your own systems. Use it to sync contacts, manage CRM records, trigger campaigns, build segments, manage journeys, and administer projects and organisations.

​
Base URL

The public surface is split across two prefixes:

​
Authentication

All requests require a bearer token. See the Authentication guide for key types, scopes, and rotation.

​
Conventions

The Main API is rolling out a set of wire-level conventions in stages. Per-IP edge rate limits, cursor pagination, and the X-Request-Id correlation header are live today. Per-key rate limits with read/write split, the MCP boost, Idempotency-Key enforcement, full Spotzee-Version validation, and the RFC 7807 error envelope ship in a future release. Each guide flags the live-vs-rolling-out state for its concern.

​
Endpoints

Endpoint pages are auto-generated from the OpenAPI specification. See the sidebar for the full list, grouped by resource (Users, CRM, Lists, Subscriptions, Campaigns, Journeys, Templates, Events, Tags, Projects, API keys, Organisation).
CRM endpoints are part of the generated Main API reference. Use the CRM group to read contacts, companies, activities, pipeline stages, properties, and saved views for the project authenticated by your API key.

​
CRM access

CRM endpoints use the project-scoped /client surface. Generated CRM paths such as /crm/contacts are relative to:
Use a project secret key (sk_) in the Authorization header. CRM reads require a secret project key. CRM writes require a secret project key with the project editor role or higher. Public CRM properties appear in each record’s properties object. Hidden and classified CRM properties are not exposed in CRM API responses. OpenAPI spec URL: https://apix.spotzee.com/api/openapi.json

​
Next steps

CRM guide

Organise contacts, companies, activities, and pipeline stages.

Authentication

Key types, scopes, and rotation.

Errors

Status codes and the code catalogue.