All ConformaESG endpoints are rooted under {{BASE_URL}}/api/v1/ and speak JSON over HTTPS. See Configuration for the base URL and API Conventions for shared patterns (identifiers, dates, errors, filtering).
Endpoint groups
| Group | Base path | Purpose |
|---|---|---|
| Authentication | /auth, /health | Login, logout, CSRF, session introspection and health checks |
| API Keys | /auth/api-keys | Personal access tokens and grantable scopes |
| Legacy Session & Entitlements | /me | Legacy user context endpoints for older integrations |
| Account Users | /account/users | Tenant users, roles and module permissions |
| Suppliers | /suppliers | CRUD for suppliers |
| Supplier Certifications | /supplier-certifications | Compliance certificates attached to suppliers |
| Supplier Documents | /suppliers/{supplierId}/... | Supplier-owned document upload surfaces |
| Supplier Products | /supplier/products | Catalog of items each supplier offers |
| Company Products | /company/products | Your own product catalog |
| Company Profile | /company/profile | Company profile and profile-owned documents |
| Documents | /documents | Generic document metadata, upload, download and presigned flow |
| Product Materials | /product/materials | Raw materials, purchases, activities and documents |
| Chemicals | /chemicals | Chemical products with ZDHC levels |
| Purchases | /purchases | Supplier purchase orders with status lifecycle |
| Purchase Documents | /purchases/{purchaseId}/documents | Purchase-owned document uploads |
| Textile — Fabrics | /textile/fabrics | Fabric product catalog |
| Textile — Yarns | /textile/yarns | Yarn product catalog |
| Textile — Fibers | /textile/fibers | Fiber product catalog |
| Product Traceability | /product/traceability | End-to-end product journeys with processing stages |
| Traceability Records | /traceability | Batch-level traceability records |
| External Supplier Wizard | /external-supplier-wizard | Final supplier wizard submission |
Common behavior
- List endpoints use the response shape documented per resource: plain arrays,
itemsenvelopes ordata/meta/facetsenvelopes. - Path identifiers are always UUIDs.
- All fields use camelCase.
- Errors follow the standard error envelope.
HTTP verbs at a glance
| Verb | Meaning |
|---|---|
GET /resource | List resources (may accept query filters) |
GET /resource/{id} | Fetch a single resource |
POST /resource | Create a resource |
PATCH /resource/{id} | Partially update a resource |
DELETE /resource/{id} | Delete a resource |
Note
The canonical definition of the API is the OpenAPI spec (openapi.json). This reference is a human-friendly restatement of the same contract — whenever the two differ, the spec wins.