API Overview
The Synaptyx public API is a stable, read-only v1 for pulling your data into
your own tools, warehouses, and dashboards. Everything is under /api/v1/*, returns
JSON, and is authenticated with an API key.
The v1 API is read-only by design — it’s for reporting and data export. To
change things programmatically (update a flow, create an alert…), use the
MCP server, which exposes write tools with dry-run safety.
Quick start
Create a key
In Settings → API Keys, create a read-only key and select
the resources it may read. Copy the syx_live_… value — it’s shown once.
Call an endpoint
Pass the key in the Authorization header with the ApiKey scheme:
curl https://app.synaptyx.pro/api/v1/stats/overview?days=7 \
-H "Authorization: ApiKey syx_live_your_key_here"Paginate
List endpoints return a nextCursor; pass it back to get the next page until
hasMore is false.
What you can read
| Resource | Endpoint family | Scope |
|---|---|---|
| Conversions | /api/v1/conversions | read:conversions |
| Clicks | /api/v1/clicks | read:clicks |
| Campaigns | /api/v1/campaigns | read:campaigns |
| Offers | /api/v1/offers | read:offers |
| Landing pages | /api/v1/landing-pages | read:landing-pages |
| Traffic sources | /api/v1/traffic-sources | read:traffic-sources |
| Stats | /api/v1/stats/* | read:stats |
| Reports | /api/v1/reports | read:reports |
| Search | /api/v1/{conversions,campaigns}/search | search:* |
Full details on the Endpoint Reference.
Interactive docs
There’s a hosted, try-it API explorer (Scalar) and an OpenAPI spec:
| What | URL |
|---|---|
| Interactive docs | https://app.synaptyx.pro/api/v1/docs |
| OpenAPI JSON | https://app.synaptyx.pro/api/v1/docs/json |
These are public so you can explore the schema before writing code. Each endpoint includes cURL / Python / Node samples.
Conventions
- Base URL:
https://app.synaptyx.pro - Auth:
Authorization: ApiKey syx_live_… - Pagination: opaque cursors (
nextCursor/hasMore) - Errors: JSON
{ "error": "<snake_case_code>" }with standard HTTP statuses - Scoping: every response is limited to the data your key’s owner can see
Full API access (the v1 read scopes) is a Scale-plan feature; MCP access is
Pro/Scale. See Authentication for exact plan gating.