Synaptiik API v1

Public API documentation

Access your Synaptiik data (projects, shoots, clients, invoices) from your third-party tools via a REST API secured with a Personal Access Token.

Authentication

All requests require a Personal Access Token (PAT) in the Authorization.

Authorization: Bearer syn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

Generate your tokens in Settings → API → Access tokens.

Base URL

https://synaptiik.fr/api/v1

Rate limiting

60 requests per minute per token. Response headers indicate your quota:

X-RateLimit-Limit
60
X-RateLimit-Remaining
58
X-RateLimit-Reset
1714300860

Endpoints

GET/api/v1/projectsprojects:read

Lists your organization's projects with pagination.

Parameters: limit (max 100) · offset · status
GET/api/v1/shootsshoots:read

Lists shoot sessions with filtering by project.

Parameters: limit · offset · status · project_id
GET/api/v1/clientsclients:read

Lists the client portfolio with search by name.

Parameters: limit · offset · search
GET/api/v1/invoicesinvoices:read

Lists financial artifacts (invoices, quotes, credit notes).

Parameters: limit · offset · paid (true/false) · project_id

OpenAPI 3.1 specification

Download the full spec to import it into Postman, Insomnia, or your preferred HTTP client.

Download openapi.json

SDKs

JavaScript / TypeScript
npm install @synaptiik/sdk
import { SynaptiikClient } from '@synaptiik/sdk';
const client = new SynaptiikClient({ token: 'syn_live_...' });
const { data } = await client.projects.list();
Python
pip install synaptiik
from synaptiik import SynaptiikClient
client = SynaptiikClient(token="syn_live_...")
projects = client.projects.list()
PHP
composer require synaptiik/sdk
use Synaptiik\Client;
$client = new Client(['token' => 'syn_live_...']);
$projects = $client->projects()->list();