Keychain API
The Keychain OS API is organized around REST. It accepts query-string parameters, returns JSON-encoded responses, and uses standard HTTP response codes and authentication.
The API is read-only — it gives you access to the data inside your Keychain OS account but does not modify it. Use it to pull product formulations, raw-material pricing, inventory movements, supplier records, production costs, order history and many more into your own reports, dashboards, cost calculators, and third-party integrations.
Every response is scoped to your organization. The API key you authenticate with determines which manufacturer's data you can access, so you will only ever see your own SKUs, vendors, inventory, and orders.
All list endpoints return paginated results. You can control page size with the limit parameter (max 100) and navigate with offset. The response always includes a pagination object with the total count so you know how many records exist.
Authentication
- API Key: ApiKeyAuth
API key provided by Keychain. Contact [email protected] to obtain one.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-API-Key |
Contact