Partner Suite

Build on top of everything

A REST API with Swagger docs, per-client scoped keys, and OAuth 2.1 authorization. Pull data, push updates, and integrate Synup into your existing stack.

REST · JSON OpenAPI 3.0 OAuth 2.1 + PKCE 9 categories

Start free trial Read the docs

Swagger UI live in your dashboard 14-day free trial · No credit card

at-risk-clients.js JavaScript

// Clients whose health score dropped below 60
const res = await fetch(
  'https://api.synup.com/v1/clients?health_lt=60&limit=2', {
    headers: {
      'Authorization': 'Bearer sk_live_a1b2c3d4e5f6...',
      'Content-Type': 'application/json'
    }
  }
);

const { data } = await res.json();

200 OK application/json 142 ms

{
  "data": [
    { "id": "cl_8f2ka91", "name": "Harbor Coffee",
      "health": 45, "rating": 3.6, "status": "at_risk" },
    { "id": "cl_3md7x02", "name": "Lakeside Pet Clinic",
      "health": 34, "rating": 3.1, "status": "at_risk" }
  ],
  "has_more": false
}

Agencies build on the Synup API

REST API

Every resource, one consistent API

The Synup API follows REST conventions — resource-oriented URLs, standard HTTP methods, JSON responses. The Swagger UI gives you a browsable reference with try-it-out capability. Coverage spans listings, reviews, social, GBP, analytics, campaigns, and reseller operations.

RESTful, resource-oriented, JSON in and out

Swagger UI with try-it-out for every endpoint

Coverage: Listings, Reviews, Social, GBP, Analytics, Campaigns, Reseller

Consistent error responses with standard HTTP status codes

SAPI referencev1 Filter endpoints

Method	Endpoint	Description
GET	/v1/clients	List all clients
GET	/v1/clients/:id	Get client detail
POST	/v1/clients	Create a client
GET	/v1/clients/:id/reviews	List reviews for a client
POST	/v1/clients/:id/posts	Create a social post
GET	/v1/clients/:id/listings	Get listing status
GET	/v1/clients/:id/seo/rankings	Get SEO rankings
GET	/v1/clients/:id/aeo/visibility	Get AI visibility score

View full API reference 8 of 140+ endpoints

api.synup.com/docs

SSynup APIv1.0.4 OAS 3.0

Clients GETPOSTPUTDEL

ReviewsGETPOST9 ops

ListingsGETPUT14 ops

SocialGETPOSTDEL11 ops

Authentication

API keys or OAuth 2.1 — your choice

For simple integrations, generate an API key and pass it as a Bearer token. For production applications, use OAuth 2.1 with PKCE for secure, scoped access. Dynamic Client Registration (RFC 7591) lets your app register programmatically.

Bearer token auth for quick integrations

OAuth 2.1 with PKCE for production apps

Dynamic Client Registration (RFC 7591)

1-hour access tokens, 30-day refresh tokens

Scopes: mcp:read, mcp:write

Bearer tokenFastest path — one header

Authorization: Bearer sk_live_a1b2c3d4e5f6...

Scoped toAll clients

Key format64-char hex

Rotate or revoke from Settings at any time

OAuth 2.1 + PKCEFor production apps

1RegisterPOST /oauth/mcp/registerclient_id

2AuthorizeGET /oauth/mcp/authorizeconsent

3TokenPOST /oauth/mcp/tokenaccess + refresh

Scopesmcp:readmcp:write

Access token 1 hour · refresh token 30 days

Key management

Per-client scoped keys

Create API keys scoped to none, all, or specific clients. The agent uses the right key automatically when you name a client in chat. Rotate keys without downtime, and track which key is assigned to which client.

Open Settings · API keys

SAPI Keys3 active Add API key

Key	Name	Preview	Scope	Created	Actions
K01	Production — All ClientsUsed by the agent container	sk_live_a1b2...f6	All clients	2026-03-11	RotateEditDelete
K02	Bella Vista OnlyScoped to one client account	sk_live_x7y8...z9	1 client	2026-05-02	RotateEditDelete
K03	Staging (unused)No clients assigned yet	sk_test_m3n4...p5	Unassigned	2026-06-19	RotateEditDelete

Scope changes take effect on the next request — no redeploy

All keys, IDs, endpoints, and payloads on this page are illustrative samples — swap them for your own before publishing.

Everything you need to integrate

ListingsReputationSocial GBPAnalyticsCampaigns Store Locator & PagesClient ManagementReseller

Swagger UI docs

Browse every endpoint, try requests live, see response schemas. No separate docs site needed.

ClientsGETPOST

ReviewsGETPUT

Per-client key scoping

Assign each key to none, all, or specific clients. The agent uses the right key automatically.

sk_live_x7y8...z93 clients

OAuth 2.1 + PKCE

Production-grade authorization with dynamic client registration and refresh tokens.

1POST /oauth/mcp/register

2GET /oauth/mcp/authorize

3POST /oauth/mcp/token → 200

Key rotation

Generate a new key and swap it in without downtime. Old keys revoke immediately.

sk_live_a1b2...f6Rotate

API categories

Endpoints organized by domain: Listings, Reviews, Social, GBP, Analytics, Campaigns, Reseller.

ListingsReviewsSocialGBPAnalyticsCampaignsReseller

Anthropic key sync

Paste your Anthropic API key once. It syncs to the agent container and redeploys automatically.

sk-ant-...Save key

// Adrian Graphics & Marketing rollout
const results = await synup.get('/v1/campaigns/results');
// nearly every client: increased sales revenue
// many clients: 400%+ within first few months

AG Adrian Graphics & MarketingAgency

Adrian rolled out Synup quickly across many agency clients — combining presence, reputation, and campaigns at once. Results came almost overnight: nearly every client saw increased sales revenue within the first few months.

Adrian Graphics & MarketingAgency serving Safeway, SportClips, and others

Read the full story →

FAQ

What developers ask before the first request

What can I do with the API?

Pull client data (listings, reviews, rankings, AI visibility), create and manage social posts, trigger scans, manage clients, and automate workflows. Coverage spans the full Synup product surface.

How do I authenticate?

For quick integrations, use a Bearer token (API key). For production apps, use OAuth 2.1 with PKCE. Both methods are documented in the Swagger UI.

Can I scope API keys to specific clients?

Yes. Each key can be assigned to no clients, all clients, or a specific subset. The agent uses the right key automatically based on context.

Is there a rate limit?

Yes. Rate limits are documented per endpoint in the Swagger UI. Standard limits are generous for typical integration use cases.

What's the difference between the API and MCP?

The API is REST — traditional HTTP endpoints for pulling data and pushing updates. MCP is a protocol for AI agents to call Synup tools natively. Use the API for custom integrations; use MCP for AI-agent workflows.

Is there an SDK?

The API uses standard REST conventions, so any HTTP client works. We recommend using the Swagger-generated client for your language of choice.

Start building

Create a key, hit an endpoint, and read the response. The Swagger UI is live in your dashboard the moment your trial starts.

curl https://api.synup.com/v1/clients -H "Authorization: Bearer $SYNUP_KEY"

Start free trial Read the docs

No credit card required Live sync in minutes Cancel anytime