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, mint 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 HTTPS.
Getting started
To get started, create an API key from API Keys in the Synex application, then make your first request in the 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.
Guides
Authentication
Authenticate requests with an API key, and scope keys to teams and ontologies.
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.
Audit events
Read the team's audit log of every read and mutation, filtered by user, passport, or action.
Lab
Run PassQL queries, preview and execute bulk transforms, and roll them back — all over the Lab read model.