The Superfood API lets your other systems work with your Superfood data: pull products, customers, complaints, job sheets, sales lines and more into n8n, Make, Power BI, a spreadsheet or your own code, and send form submissions in from outside. Every key belongs to one company and only ever sees that company's records.
Read 23 tables across products, sales, quality, maintenance and people, with paging, change tracking and filters.
Create and update records in 12 main tables (complaints, NCRs, incidents, maintenance, training, production, pest control, suppliers and register rows), with the same checks and amendment logging as the app.
Read your forms and their questions, and submit completed forms into the QA queue.
Manage keys and watch usage in Company settings > API: create, rename, rotate and revoke keys, choose read only or read and write, and see every call.
Base URL: https://app.superfoodapps.com/api/v1
Step 1: Create an API key
Company admins manage keys in Company settings > API (open the S menu, then Company settings, then the API tab).
Press New key, give it a name that says where it will be used (for example "n8n" or "Power BI") and choose the access.
Read only keys can read every table and form. Read and write keys can also submit forms and create and update records.
The full key (it starts with
sf_live_) is shown once. Copy it straight into the system that will use it. Superfood keeps only a fingerprint of it, so nobody can show it to you again.Use one key per connection. Then the usage report shows which system made which calls, and you can revoke one without breaking the others.
Rename, change access, rotate or revoke
Rename changes the label only; the key keeps working.
Access switches between read only and read and write straight away.
Rotate gives the key a new secret. The old one stops working at once, so paste the new one where it is used.
Revoke blocks every request with the key from that moment. It cannot be undone.
Every change is recorded in the amendment register with who made it.
Step 2: Authenticate
Send the key with every request in either header:
Authorization: Bearer sf_live_your_key_here
X-API-Key: sf_live_your_key_hereA good first call is the API index. It confirms the key works and shows its name and access:
curl -H "Authorization: Bearer sf_live_your_key_here" https://app.superfoodapps.com/api/v1{
"api": "Superfood API",
"version": "v1",
"key": { "name": "n8n", "access": "read" },
"company_id": "rec…",
"tables": ["products", "ingredients", …]
}Reading tables
| Request | What it returns |
|---|---|
GET /api/v1/tables | Every table the API serves, with its fields. |
GET /api/v1/tables/{table} | A page of records from one table. |
GET /api/v1/tables/{table}/{id} | One record by its id. |
GET /api/v1/tables/{table}/fields | One table's field list. |
Paging
Lists return 50 records by default and up to 200 with limit. Keep asking with offset set to next_offset until has_more is false.
GET /api/v1/tables/products?limit=200&offset=0
{
"object": "list",
"table": "products",
"data": [ { "id": "…", "product_name": "Greek Yoghurt 1kg", "sku": "GY1000", … } ],
"limit": 200,
"offset": 0,
"has_more": true,
"next_offset": 200
}Only what changed
Add updated_since (a date or date-time) to get only records changed since your last sync. Records come oldest change first, so you can store the last updated_at you saw and use it next time. Add order=desc for newest first.
GET /api/v1/tables/job_sheets?updated_since=2026-11-01T00:00:00ZFilters
Any text, number, id, true/false or date field can be an exact-match filter: add it as a query parameter. Use null to find empty values. Several filters must all match.
GET /api/v1/tables/complaints?status=Open
GET /api/v1/tables/job_sheets?asset_id=6f1c…&status=Completed
GET /api/v1/tables/register_entries?register_id=2b9e…
GET /api/v1/tables/products?barcode=9300000000000A field that isn't on the table, or a value of the wrong type, returns a 400 with a message saying what to fix.
Linked records
Links between tables are ids: a job sheet's asset_id is an id in assets, a complaint's product_id is an id in products. Fetch the linked record with GET /api/v1/tables/{table}/{id}.
Tables and fields
Only the fields listed here are returned. Custom fields arrive in custom (keyed by field id), form answers in form_data and register rows in data (keyed by the register's column keys).
Products and production
Products: products
The one product book every module shares: codes, sizes, prices, pallet details and custom fields. Changes are tracked on updated_at. Read only through the API.
| Field | Type | Notes |
|---|---|---|
id | id | |
product_name | text | |
display_name | text | |
sku | text | |
barcode | text | |
product_description | text | |
unit_size | text | |
unit_size_g | number | |
unit_of_measure | text | |
pack_size_text | text | |
qty_uom | number | |
weight_system | text | |
nominal_weight_g | number | |
tare_weight_g | number | |
shelf_life_days | number | |
tun | text | Trade unit number (carton barcode) |
gst | text | |
unit_cost | number | |
price_tier_1 | number | |
price_tier_2 | number | |
price_tier_3 | number | |
price_tier_4 | number | |
price_tier_5 | number | |
rrp_tier_1 | number | |
rrp_tier_2 | number | |
rrp_tier_3 | number | |
woolworths_product_code | text | |
coles_product_code | text | |
otr_product_code | text | |
cartons_per_layer | number | |
max_layers_per_pallet | number | |
max_cartons_per_pallet | number | |
carton_dimensions | text | |
category_id | id | |
site_id | id | |
product_photo | text | Image URL |
custom | object | Your custom fields, keyed by field id |
created_at | date-time | |
updated_at | date-time |
Ingredients: ingredients
Ingredients used in recipes, with allergens, nutrition per 100g, supplier and cost. Changes are tracked on updated_at. Read only through the API.
| Field | Type | Notes |
|---|---|---|
id | id | |
name | text | |
item_code | text | |
descriptor | text | |
listing | text | How it reads on the ingredient list |
ingredient_type | text | |
allergens | object | |
may_contain | text | |
percent_australian | number | |
nutrition | object | |
supplier_name | text | |
cost_per_kg | number | |
uom | text | |
size_text | text | |
sub_recipe_id | id | |
is_archived | true/false | |
created_at | date-time | |
updated_at | date-time |
Recipes: recipes
Recipes and sub-recipes with batch size, yield and the computed label values. Changes are tracked on updated_at. Read only through the API.
| Field | Type | Notes |
|---|---|---|
id | id | |
name | text | |
notes | text | |
instructions | text | |
batch_g | number | |
yield_pct | number | |
is_sub_recipe | true/false | |
hsr_category | text | |
computed | object | Nutrition, allergens and percentages, as last calculated |
computed_at | date-time | |
is_archived | true/false | |
created_at | date-time | |
updated_at | date-time |
Production runs: production_runs
Planned and completed production runs by product and date. Changes are tracked on updated_at. Read and write keys can create and update it.
| Field | Type | Notes |
|---|---|---|
id | id | |
run_date | date | |
product_id | id | |
product_text | text | |
qty | number | |
status | text | |
asset_ids | list | |
notes | text | |
source | text | |
parent_run_id | id | |
created_by | text | |
created_at | date-time | |
updated_at | date-time |
Sales
Stores and customers: customers
The one store and customer book: codes, contacts, address, retailer and location. Changes are tracked on updated_at. Read only through the API.
| Field | Type | Notes |
|---|---|---|
id | id | |
name | text | |
customer_code | text | |
customer_type | text | |
retailer | text | |
account_id | id | |
master_store_id | id | |
phone | text | |
sales_email | text | |
accounts_email | text | |
address | text | |
latitude | number | |
longitude | number | |
woolworths_store_account_code | text | |
coles_store_code | text | |
otr_store_code | text | |
account_manager_id | id | |
sales_12m | number | |
sales_prev_12m | number | |
is_obsolete | true/false | |
custom | object | |
archived_at | date-time | |
created_at | date-time | |
updated_at | date-time |
Promotions: promotions
Promotions from the Promotions area: dates, retailer, status, spend and results. Changes are tracked on updated_at. Read only through the API.
| Field | Type | Notes |
|---|---|---|
id | id | |
promo_id | text | Your promotion number |
promo_name | text | |
promo_type | text | |
status | text | |
retailer | text | |
account_id | id | |
customer_id | id | |
in_store_start | date | |
in_store_end | date | |
valid_from | date | |
valid_to | date | |
price_tier | text | |
claim_type | text | |
promo_spend | number | |
actual_spend | number | |
expected_sales_units | number | |
sales_units_sold | number | |
expected_sales_value | number | |
actual_sales_value | number | |
budget_id | id | |
series_id | id | |
series_name | text | |
pending_approval | true/false | |
comments | text | |
created_at | date-time | |
updated_at | date-time |
Sales lines: sales_lines
Invoiced sales lines from your imports and accounting syncs (one row per invoice line). Changes are tracked on created_at. Read only through the API.
| Field | Type | Notes |
|---|---|---|
id | id | |
sale_date | date | |
doc_ref | text | Invoice or document number |
customer_id | id | |
customer_code | text | |
customer_name | text | |
product_id | id | |
product_sku | text | |
product_name | text | |
qty | number | |
unit_price | number | |
value | number | |
source | text | |
import_id | id | |
attributes | object | |
created_at | date-time |
EasyImport orders: orders
Customer orders read by EasyImport, with the extracted lines in order_data. Changes are tracked on updated_at. Read only through the API.
| Field | Type | Notes |
|---|---|---|
id | id | |
status | text | |
source | text | |
from_email | text | |
subject | text | |
received_at | date-time | |
order_data | object | Header and lines as read from the order |
custom_values | object | |
approved_at | date-time | |
approved_by | text | |
merged_at | date-time | |
created_at | date-time | |
updated_at | date-time |
Quality and food safety
Form submissions: form_submissions
Every completed form, with its answers and QA sign-off state. Changes are tracked on submitted_at. Read only through the API.
| Field | Type | Notes |
|---|---|---|
id | id | |
form_id | text | |
submission_name | text | |
submission_number | number | |
submitted_by | text | |
user_email | text | |
submitted_at | date-time | |
status | text | |
form_data | object | Answers keyed by field id |
notes | text | |
qa_status | text | |
qa_reviewed_by | text | |
qa_reviewed_at | date-time | |
qa_approved_by | text | |
qa_approved_at | date-time | |
qa_notes | text | |
site_id | id |
Registers: registers
Your registers (chemicals, scales, thermometers, custom) and their column definitions. Changes are tracked on updated_at. Read only through the API.
| Field | Type | Notes |
|---|---|---|
id | id | |
name | text | |
kind | text | |
description | text | |
columns | object | Column keys, labels and types |
created_by | text | |
created_at | date-time | |
updated_at | date-time |
Register entries: register_entries
The rows of every register; data is keyed by the register's column keys. Changes are tracked on updated_at. Read and write keys can create and update it.
| Field | Type | Notes |
|---|---|---|
id | id | |
register_id | id | |
data | object | |
attachments | object | |
is_archived | true/false | |
created_by | text | |
created_at | date-time | |
updated_at | date-time |
Customer complaints: complaints
Customer complaints with product, batch, root cause and actions. Changes are tracked on updated_at. Read and write keys can create and update it.
| Field | Type | Notes |
|---|---|---|
id | id | |
complaint_number | number | |
status | text | |
date_of_complaint | date | |
source | text | |
store_or_customer | text | |
customer_name | text | |
contact_name | text | |
customer_email | text | |
customer_phone | text | |
product_id | id | |
product_text | text | |
batch_code | text | |
best_before | text | |
site | text | |
problem_type | text | |
problem_area | text | |
details | text | |
root_cause | text | |
immediate_action | text | |
long_term_action | text | |
response_to_customer | text | |
corrective_action_required | true/false | |
close_out_date | date | |
assigned_email | text | |
reported_by | text | |
ncr_id | id | |
custom | object | |
created_at | date-time | |
updated_at | date-time |
Non-conformance reports: ncrs
NCRs with severity, root cause, corrective action and close-out. Changes are tracked on updated_at. Read and write keys can create and update it.
| Field | Type | Notes |
|---|---|---|
id | id | |
ncr_number | number | |
title | text | |
status | text | |
date_of_infringement | date | |
issue_type | text | |
issue_severity | text | |
ncr_type | text | |
description | text | |
root_cause | text | |
corrective_action | text | |
site | text | |
responsible_email | text | |
reported_by | text | |
close_out_date | date | |
complaint_id | id | |
custom | object | |
created_at | date-time | |
updated_at | date-time |
Incident reports: incidents
Hazards and incidents with location, injuries, damage and corrective action. Changes are tracked on updated_at. Read and write keys can create and update it.
| Field | Type | Notes |
|---|---|---|
id | id | |
incident_number | number | |
status | text | |
incident_at | date-time | |
location | text | |
exact_location | text | |
incident_types | list | |
result_of | list | |
report | text | |
injured_body_parts | text | |
medical_treatment | text | |
property_damage | text | |
corrective_action | text | |
responsible_person | text | |
completion_date | date | |
reported_by_email | text | |
created_at | date-time | |
updated_at | date-time |
Pest control visits: pest_visits
Pest contractor visits with the checks and recommendations. Changes are tracked on updated_at. Read and write keys can create and update it.
| Field | Type | Notes |
|---|---|---|
id | id | |
visit_date | date | |
visit_type | text | |
contractor | text | |
technician | text | |
summary | text | |
recommendations | text | |
checks | object | |
created_by | text | |
created_at | date-time | |
updated_at | date-time |
Site and maintenance
Assets: assets
The asset register: machines and equipment, location, serial and risk rating. Changes are tracked on updated_at. Read and write keys can create and update it.
| Field | Type | Notes |
|---|---|---|
id | id | |
asset_number | number | |
custom_asset_number | text | |
name | text | |
status | text | |
item_type | text | |
location | text | |
serial_number | text | |
year_of_manufacture | text | |
key_parts | text | |
maintenance_notes | text | |
severity | text | |
likelihood | text | |
risk_score | text | |
supplier_ids | list | |
archived_at | date-time | |
created_at | date-time | |
updated_at | date-time |
Job sheets: job_sheets
Maintenance job sheets (breakdown and preventative) from raised to completed. Changes are tracked on updated_at. Read and write keys can create and update it.
| Field | Type | Notes |
|---|---|---|
id | id | |
job_number | number | |
status | text | |
sheet_type | text | |
details | text | |
asset_id | id | |
supplier_id | id | |
pm_schedule_id | id | |
scheduled_date | date | |
due_date | date | |
completed_date | date | |
assigned_email | text | |
completed_by | text | |
completed_notes | text | |
invasive | true/false | |
authorised_at | date-time | |
authorised_by | text | |
approved_at | date-time | |
approved_by | text | |
archived_at | date-time | |
created_at | date-time | |
updated_at | date-time |
Preventative schedules: pm_schedules
Preventative maintenance schedules per asset with frequency and next due date. Changes are tracked on updated_at. Read and write keys can update it.
| Field | Type | Notes |
|---|---|---|
id | id | |
asset_id | id | |
frequency | text | |
notes | text | |
last_maintenance_date | date | |
next_due | date | |
default_staff_email | text | |
default_supplier_id | id | |
is_active | true/false | |
archived_at | date-time | |
created_at | date-time | |
updated_at | date-time |
Spare parts: spare_parts
Spare parts with stock on hand and reorder levels. Changes are tracked on updated_at. Read and write keys can create and update it.
| Field | Type | Notes |
|---|---|---|
id | id | |
name | text | |
part_no | text | |
stock_on_hand | number | |
min_stock | number | |
max_stock | number | |
order_qty | number | |
lead_time_days | number | |
supplier_id | id | |
notes | text | |
archived_at | date-time | |
created_at | date-time | |
updated_at | date-time |
Suppliers: suppliers
The one supplier book shared by maintenance, procurement and specifications. Changes are tracked on updated_at. Read and write keys can create and update it.
| Field | Type | Notes |
|---|---|---|
id | id | |
business_name | text | |
supplier_type | text | |
email | text | |
phone | text | |
address | text | |
notes | text | |
staff_email | text | |
proc_categories | list | |
custom | object | |
archived_at | date-time | |
created_at | date-time | |
updated_at | date-time |
Visitor entries: visitors
Visitor sign-ins and sign-outs from your check-in points. Changes are tracked on signed_in_at. Read only through the API.
| Field | Type | Notes |
|---|---|---|
id | id | |
register_id | id | The check-in point |
visitor_name | text | |
visitor_company | text | |
visitor_phone | text | |
host_name | text | |
host_email | text | |
signed_in_at | date-time | |
signed_out_at | date-time | |
sign_out_method | text | |
data | object | Answers to the check-in questions |
created_at | date-time |
People
Staff: staff
The staff register: names, contact details, role, staff ID and member type. Changes are tracked on updated_at. Read only through the API.
| Field | Type | Notes |
|---|---|---|
id | id | |
staff_id | text | |
name | text | |
first_name | text | |
last_name | text | |
email | text | |
phone | text | |
title_department | text | |
role | text | |
member_type | text | |
status | text | |
is_active | true/false | |
created_at | date-time | |
updated_at | date-time |
Training records: training_records
Completed training per person with expiry dates. Changes are tracked on updated_at. Read and write keys can create and update it.
| Field | Type | Notes |
|---|---|---|
id | id | |
user_email | text | |
staff_name | text | |
training_name | text | |
provider | text | |
completed_date | date | |
expiry_date | date | |
notes | text | |
source | text | |
memo_id | id | |
submission_id | id | |
created_at | date-time | |
updated_at | date-time |
Creating and updating records
Read and write keys can create records with POST and change them with PATCH. Deleting is not offered: archive or close a record in the app.
| Request | What it does |
|---|---|
POST /api/v1/tables/{table} | Create one record. Replies 201 with the saved record. |
PATCH /api/v1/tables/{table}/{id} | Change only the fields you send. Replies 200 with the saved record. |
A write goes through exactly the same save as the app's own screens: the same required fields, numbering, checks, notifications and amendment register. The register names the key, for example "API key: n8n".
Send only the fields listed as writable below. Any other field (including
idandcompany_id) returns a 400 that lists the fields the table accepts. Records are always created in the key's own company.customand a register row'sdataare merged: send only the keys that change and the rest stay as they are. Custom field keys must already exist in the app.The reply is the record as it was saved. If a field you sent wasn't stored (for example a custom field the company hasn't set up), it is listed in
not_saved, so a save never quietly drops something.warningscarries anything else you should know.GET /api/v1/tablesandGET /api/v1/tables/{table}/fieldsinclude awritesblock per table with the writable fields and what a create needs.
POST /api/v1/tables/complaints
{
"customer_name": "Jo Smith",
"details": "Mould on a loaf bought Tuesday",
"batch_code": "L1234",
"product_id": "6f1c…"
}
201 Created
{ "object": "record", "table": "complaints", "data": { "id": "…", "complaint_number": 412, "status": "Open", … } }PATCH /api/v1/tables/job_sheets/8a2d…
{ "status": "Completed", "completed_date": "2026-11-06", "completed_notes": "Belt replaced" }POST /api/v1/tables/register_entries
{ "register_id": "2b9e…", "data": { "temp": 3.5, "checked_by": "Sam" } }What each table accepts
| Table | Create | Update | Writable fields |
|---|---|---|---|
complaints | Yes | Yes | status, date_of_complaint, source, store_or_customer, customer_name, contact_name, customer_email, customer_phone, product_id, product_text, batch_code, best_before, site, problem_type, problem_area, details, root_cause, immediate_action, long_term_action, response_to_customer, corrective_action_required, close_out_date, assigned_email, reported_by, custom |
ncrs | Yes | Yes | title, status, date_of_infringement, issue_type, issue_severity, ncr_type, description, root_cause, corrective_action, site, responsible_email, reported_by, close_out_date, complaint_id, custom |
incidents | Yes | Yes | status, incident_at, location, exact_location, incident_types, result_of, report, injured_body_parts, medical_treatment, property_damage, corrective_action, responsible_person, completion_date, reported_by_email |
training_records | Yes (needs training_name) | Yes | user_email, staff_name, training_name, provider, completed_date, expiry_date, notes |
production_runs | Yes | Yes | run_date, product_id, product_text, qty, status, asset_ids, notes |
pest_visits | Yes | Yes | visit_date, visit_type, contractor, technician, summary, recommendations, checks |
assets | Yes (needs name) | Yes | name, custom_asset_number, status, item_type, location, serial_number, year_of_manufacture, key_parts, maintenance_notes, severity, likelihood, risk_score, supplier_ids |
job_sheets | Yes | Yes | status, sheet_type, details, asset_id, supplier_id, scheduled_date, due_date, assigned_email, completed_date, completed_by, completed_notes, invasive |
spare_parts | Yes (needs name) | Yes | name, part_no, stock_on_hand, min_stock, max_stock, order_qty, lead_time_days, supplier_id, notes |
suppliers | Yes (needs business_name) | Yes | business_name, supplier_type, email, phone, address, notes, staff_email, custom |
pm_schedules | No | Yes | frequency, notes, last_maintenance_date, default_supplier_id |
register_entries | Yes (needs register_id, data) | Yes | register_id, data, attachments |
Forms
| Request | What it does |
|---|---|
GET /api/v1/forms | Your active forms: id, name, category, frequency and how many questions. |
GET /api/v1/forms/{id} | One form with its sections and fields, ready to render in your own app. |
POST /api/v1/forms/{id}/submissions | Submit a completed form (read and write keys only). |
Form ids are the built-in codes (for example F01) or cf- followed by a custom form's id. Field types: text, textarea, number, date, time, select, radio, checkbox, email, phone, signature, table, staff-select and product-select.
POST /api/v1/forms/F01/submissions
{
"submitted_by": "Jane Smith",
"fields": {
"date": "2026-11-06",
"supplier_name": "Acme Co",
"temperature": "4.2",
"condition": "Good"
}
}
201 Created
{ "submission": { "id": "…", "submitted_at": "2026-11-06T09:14:00Z" } }Submissions land in the QA queue for sign-off, the same as a form filled in the app. Read them back from the form_submissions table.
Usage reporting
Company settings > API shows the last 7, 30 or 90 days: total requests, errors, average response time, the busiest day, a bar per day, calls by endpoint and table, calls by key, and the latest 25 calls with their result. Each key also shows when it was last used. Call history is kept for 180 days.
Errors and limits
| Status | Meaning |
|---|---|
| 400 | Something in the request needs fixing; the message says what. |
| 401 | No key, or the key is wrong or revoked. |
| 403 | The key is read only and the request writes, the key is not linked to a company, or the save isn't allowed (the message says why). |
| 404 | No such table, or no record with that id in your company. |
| 405 | That table can't be created or updated through the API. |
| 409 | The record can't change in its current state (for example it is archived); the message says what to do. |
| 500 | Something went wrong on our side. Try again; if it keeps happening, contact support. |
Every error reply is JSON: { "error": "…" }. A page holds at most 200 records; page through larger tables (the sales lines table can hold millions of rows, so use updated_since for regular syncs).
Using it with n8n, Make and Power BI
n8n: add an HTTP Request node, set Authentication to "Generic credential type" with a Header Auth credential named
Authorizationand valueBearer sf_live_…. Turn on pagination with "Update a parameter in each request":offset={{ $response.body.next_offset }}, and stop when{{ !$response.body.has_more }}.Make: use the HTTP "Make a request" module with the same header, and a Repeater or iterator over
next_offset.Power BI and Excel: Get Data > Web > Advanced, URL
https://app.superfoodapps.com/api/v1/tables/products?limit=200, and add the headerAuthorizationwithBearer sf_live_….
Keeping keys safe
A key is as powerful as a staff login for the data it can reach. Keep it in your tool's credential store, never in a shared spreadsheet or an email.
Give each system the least it needs: read only unless it has to send data in. A read and write key can change records in the writable tables, so treat it like an admin login.
If a key may have leaked, Rotate it straight away.
When you contact support, quote the key's first 12 characters (shown in the API tab), never the whole key.
Need help?
Email [email protected] with the key's name, its first 12 characters and the request you sent.
