Complete documentation for all RegEngine API endpoints
Authenticated endpoints require this header:
X-RegEngine-API-Key: rge_live_...Standard API access (tenant-scoped). An Authorization header is not accepted.
RegEngine issues the key, your workspace ID, and the ingest signing secret on request. The workspace is taken from the key, so do not send X-Tenant-ID: a value that differs from the key's workspace is refused with a 403. Ingest also needs X-Webhook-Signature.
Primary FSMA event ingestion endpoint for CTE batches
Every event needs traceability_lot_code, product_description, quantity and unit_of_measure on the event itself. The rest depend on cte_type. Event-level fields sit beside cte_type; the others go inside kdes. A missing one rejects that event inside a 200 with Missing required KDE '…'.
| cte_type | Also required on the event | Required in kdes |
|---|---|---|
| harvesting | location_name | harvest_date, reference_document |
| cooling | location_name | cooling_date, reference_document |
| initial_packing | location_name | packing_date, reference_document, harvester_business_name, harvester_business_phone |
| first_land_based_receiving | None | landing_date, receiving_location, reference_document |
| shipping | None | ship_date, ship_from_location, ship_to_location, reference_document, tlc_source_reference |
| receiving | None | receive_date, receiving_location, immediate_previous_source, reference_document, tlc_source_reference |
| transformation | location_name | transformation_date, reference_document |
GET /api/v1/records pages with limit and offset. The response carries total, the number of matching records.
limit(default: 50, max: 500)Number of items to return per page
offset(default: 0)Number of items to skip
# First page
GET /api/v1/records?limit=20
# Next page
GET /api/v1/records?limit=20&offset=20API requests are rate limited. When you exceed a limit the API returns a 429. Stop sending for 60 seconds, then retry. Some successful responses also carry these headers; treat them as optional and do not rely on them being present, and do not rely on any header on a 429.
X-RateLimit-LimitMax requests per window
X-RateLimit-RemainingRequests left in window
X-RateLimit-ResetWhen limit resets (epoch)
See Rate Limits for details.