Synex API Reference
Synex gives every product a digital product passport (DPP) — a live, structured record of what a product is, what it's made of, and where it is in its lifecycle. The Synex API lets you define your own data model, issue passports at any depth, publish them to the public, and query millions of them at once. Everything the Synex application can do, you can do over our REST API.
Getting started
To get started, create an API key from the API Keys section in the Synex application — or mint one over the API at /v1/api_keys — then make your first request in Quickstart. If you're new to Synex, read the Data model first: it explains how templates, ontologies, and passports fit together, and how the three element types (Singular, Series, and Many) let you model anything from a single SKU to millions of individual units. When you need to query or bulk-edit passport data at scale, reach for Synex Lab and its query language, PassQL. To react to changes instead of polling for them, read Events and register a webhook endpoint.
Guides
Authentication
Authenticate requests with an API key, and scope keys to teams and ontologies.
Rate limits
Read the rate-limit headers, handle 429s, and spread bulk work across fewer calls.
Resources
Templates
Reusable schema blueprints with a draft → complete lifecycle. Fork them, then instantiate them as ontologies.
Ontologies
A team's live schema, instantiated from a completed template. Creating one auto-creates its root passport.
Passports
Digital product passports — the product data records at each level of an ontology, addressed by id or path.
Compositions
Presentation layouts that control how an ontology's public passports are rendered.
Files
Upload spreadsheets and assets, then preview their sheets before starting a mass import.
Imports
Create passports in bulk from a spreadsheet, with per-row status and retries for failed rows.
Suppliers
Invite and link the companies you buy from, ask them for named values, and map their answers onto passports.
Data requests
One-off links that let a third party fill a named subset of one passport's properties, with no Synex account.
Lab
Run PassQL queries, preview and execute bulk transforms, roll them back, and export the results.
Events
The team's change feed — what changed, newest first, each event carrying a full snapshot of the object.
Webhooks
Have events POSTed to your server as they happen, signed, retried, and verifiable in constant time.
API keys
Mint, narrow, revoke and roll credentials over the API — under constraints that stop a key widening its own reach.
Audit events
Read the team's audit log of every read and mutation, and set how long each action type is kept.
Team
The team a key acts for and its member roster — how an audit entry becomes a person.
Design
The white-label theme applied to your team's public passports — palette, rounding, shadow, logo and font.