Synup Developer API

The Synup REST API lets your own applications read and write agency, client, and location data on your behalf — the same data your team sees in Synup, available to your own code.

REST over HTTPS

Predictable resource URLs, JSON bodies, standard verbs and status codes.

Bearer key or OAuth

Self-issued keys for your own systems; OAuth for apps acting on a user's behalf.

Scoped per client

A key can be restricted to specific clients — the API enforces it, not your code.

Plan-based limits

Per agency, not per key. Going over returns 429 with a Retry-After header.

Base URL

Every request in this reference is relative to:

https://ai.synup.com/api/v1

Versioning

This is version 1 of the API. All endpoints are prefixed /api/v1. Breaking changes will ship as a new version prefix, never as a silent change to /api/v1.

Get started

Create an API key from Settings → Developer, then continue to Authentication to see how to use it.

Try your first request →