API overview
Understand the Formuley API surface, the difference between public docs and gated developer tools, and which endpoint families exist.
Overview
Formuley's public developer docs explain integration setup and product boundaries. The authenticated developer area inside the app handles real account actions such as creating keys, managing webhooks, and reviewing logs.
Use the two surfaces this way:
/docs/developer/*for public setup guidance and planning/developer/*for authenticated operational work/developer/docsfor the detailed in-app reference
REST API base
The REST API lives under /api/v1.
The discovery endpoint GET /api/v1 returns service status and links to the public developer docs.
Core endpoint families
These are the main REST groups available today:
/api/v1/formulas/api/v1/ingredients/api/v1/batches/api/v1/orders/api/v1/labels/*/api/v1/compliance/*/api/v1/webhooks*
Advanced integration families
Formuley also exposes higher-tier integration endpoints for non-trivial data movement:
- bulk operations under
/api/v1/bulk/... - raw paginated records under
/api/v1/data/[type] - asynchronous exports under
/api/v1/exports
These are better fits for migrations, sync jobs, BI pipelines, and warehouse exports than ordinary CRUD polling, but availability depends on plan.
Plan boundaries
Core REST API access and webhook management are available on Business tier and above.
The higher-volume integration surfaces have stricter gates:
- bulk operations require Lab or Enterprise
- raw data endpoints require Lab or Enterprise
- export jobs require Enterprise
SCIM is separate from the REST API and belongs to the enterprise identity workflow.
If you need API keys, webhook management, or request logs, sign in and use:
/developer/api-keys/developer/webhooks/developer/logs/developer/docs
When to use each surface
- Use the REST API for transactional integrations and app-to-app workflows.
- Use webhooks when you need event-driven updates instead of polling.
- Use raw data and exports for analytics, warehousing, and scheduled sync jobs when your plan includes those surfaces.
- Use SCIM only for enterprise user provisioning and deprovisioning.
Expected result
After reading this page, you should know:
- where the API lives
- which endpoint families exist
- which documentation surface is public versus gated
- which next guide to open for authentication or sync design
Next docs
Related Docs
Authentication and scopes
Create API keys, use the correct bearer format, understand scopes, and interpret rate-limit and authorization failures.
Data sync and exports
Choose between bulk operations, raw data endpoints, and export jobs for migration, analytics, and downstream sync workflows.
Need support instead?
Use the Help Center for troubleshooting, billing questions, account issues, and product guidance once your setup is already in motion.