Superfood API: keys, tables and endpoints

Connect n8n, Make, Power BI or your own code: create API keys, read every main table, submit forms and watch usage.

Table of contents

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_here

A 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

RequestWhat it returns
GET /api/v1/tablesEvery 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}/fieldsOne 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:00Z

Filters

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=9300000000000

A 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.

FieldTypeNotes
idid
product_nametext
display_nametext
skutext
barcodetext
product_descriptiontext
unit_sizetext
unit_size_gnumber
unit_of_measuretext
pack_size_texttext
qty_uomnumber
weight_systemtext
nominal_weight_gnumber
tare_weight_gnumber
shelf_life_daysnumber
tuntextTrade unit number (carton barcode)
gsttext
unit_costnumber
price_tier_1number
price_tier_2number
price_tier_3number
price_tier_4number
price_tier_5number
rrp_tier_1number
rrp_tier_2number
rrp_tier_3number
woolworths_product_codetext
coles_product_codetext
otr_product_codetext
cartons_per_layernumber
max_layers_per_palletnumber
max_cartons_per_palletnumber
carton_dimensionstext
category_idid
site_idid
product_phototextImage URL
customobjectYour custom fields, keyed by field id
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
nametext
item_codetext
descriptortext
listingtextHow it reads on the ingredient list
ingredient_typetext
allergensobject
may_containtext
percent_australiannumber
nutritionobject
supplier_nametext
cost_per_kgnumber
uomtext
size_texttext
sub_recipe_idid
is_archivedtrue/false
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
nametext
notestext
instructionstext
batch_gnumber
yield_pctnumber
is_sub_recipetrue/false
hsr_categorytext
computedobjectNutrition, allergens and percentages, as last calculated
computed_atdate-time
is_archivedtrue/false
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
run_datedate
product_idid
product_texttext
qtynumber
statustext
asset_idslist
notestext
sourcetext
parent_run_idid
created_bytext
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
nametext
customer_codetext
customer_typetext
retailertext
account_idid
master_store_idid
phonetext
sales_emailtext
accounts_emailtext
addresstext
latitudenumber
longitudenumber
woolworths_store_account_codetext
coles_store_codetext
otr_store_codetext
account_manager_idid
sales_12mnumber
sales_prev_12mnumber
is_obsoletetrue/false
customobject
archived_atdate-time
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
promo_idtextYour promotion number
promo_nametext
promo_typetext
statustext
retailertext
account_idid
customer_idid
in_store_startdate
in_store_enddate
valid_fromdate
valid_todate
price_tiertext
claim_typetext
promo_spendnumber
actual_spendnumber
expected_sales_unitsnumber
sales_units_soldnumber
expected_sales_valuenumber
actual_sales_valuenumber
budget_idid
series_idid
series_nametext
pending_approvaltrue/false
commentstext
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
sale_datedate
doc_reftextInvoice or document number
customer_idid
customer_codetext
customer_nametext
product_idid
product_skutext
product_nametext
qtynumber
unit_pricenumber
valuenumber
sourcetext
import_idid
attributesobject
created_atdate-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.

FieldTypeNotes
idid
statustext
sourcetext
from_emailtext
subjecttext
received_atdate-time
order_dataobjectHeader and lines as read from the order
custom_valuesobject
approved_atdate-time
approved_bytext
merged_atdate-time
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
form_idtext
submission_nametext
submission_numbernumber
submitted_bytext
user_emailtext
submitted_atdate-time
statustext
form_dataobjectAnswers keyed by field id
notestext
qa_statustext
qa_reviewed_bytext
qa_reviewed_atdate-time
qa_approved_bytext
qa_approved_atdate-time
qa_notestext
site_idid

Registers: registers

Your registers (chemicals, scales, thermometers, custom) and their column definitions. Changes are tracked on updated_at. Read only through the API.

FieldTypeNotes
idid
nametext
kindtext
descriptiontext
columnsobjectColumn keys, labels and types
created_bytext
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
register_idid
dataobject
attachmentsobject
is_archivedtrue/false
created_bytext
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
complaint_numbernumber
statustext
date_of_complaintdate
sourcetext
store_or_customertext
customer_nametext
contact_nametext
customer_emailtext
customer_phonetext
product_idid
product_texttext
batch_codetext
best_beforetext
sitetext
problem_typetext
problem_areatext
detailstext
root_causetext
immediate_actiontext
long_term_actiontext
response_to_customertext
corrective_action_requiredtrue/false
close_out_datedate
assigned_emailtext
reported_bytext
ncr_idid
customobject
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
ncr_numbernumber
titletext
statustext
date_of_infringementdate
issue_typetext
issue_severitytext
ncr_typetext
descriptiontext
root_causetext
corrective_actiontext
sitetext
responsible_emailtext
reported_bytext
close_out_datedate
complaint_idid
customobject
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
incident_numbernumber
statustext
incident_atdate-time
locationtext
exact_locationtext
incident_typeslist
result_oflist
reporttext
injured_body_partstext
medical_treatmenttext
property_damagetext
corrective_actiontext
responsible_persontext
completion_datedate
reported_by_emailtext
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
visit_datedate
visit_typetext
contractortext
techniciantext
summarytext
recommendationstext
checksobject
created_bytext
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
asset_numbernumber
custom_asset_numbertext
nametext
statustext
item_typetext
locationtext
serial_numbertext
year_of_manufacturetext
key_partstext
maintenance_notestext
severitytext
likelihoodtext
risk_scoretext
supplier_idslist
archived_atdate-time
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
job_numbernumber
statustext
sheet_typetext
detailstext
asset_idid
supplier_idid
pm_schedule_idid
scheduled_datedate
due_datedate
completed_datedate
assigned_emailtext
completed_bytext
completed_notestext
invasivetrue/false
authorised_atdate-time
authorised_bytext
approved_atdate-time
approved_bytext
archived_atdate-time
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
asset_idid
frequencytext
notestext
last_maintenance_datedate
next_duedate
default_staff_emailtext
default_supplier_idid
is_activetrue/false
archived_atdate-time
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
nametext
part_notext
stock_on_handnumber
min_stocknumber
max_stocknumber
order_qtynumber
lead_time_daysnumber
supplier_idid
notestext
archived_atdate-time
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
business_nametext
supplier_typetext
emailtext
phonetext
addresstext
notestext
staff_emailtext
proc_categorieslist
customobject
archived_atdate-time
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
register_ididThe check-in point
visitor_nametext
visitor_companytext
visitor_phonetext
host_nametext
host_emailtext
signed_in_atdate-time
signed_out_atdate-time
sign_out_methodtext
dataobjectAnswers to the check-in questions
created_atdate-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.

FieldTypeNotes
idid
staff_idtext
nametext
first_nametext
last_nametext
emailtext
phonetext
title_departmenttext
roletext
member_typetext
statustext
is_activetrue/false
created_atdate-time
updated_atdate-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.

FieldTypeNotes
idid
user_emailtext
staff_nametext
training_nametext
providertext
completed_datedate
expiry_datedate
notestext
sourcetext
memo_idid
submission_idid
created_atdate-time
updated_atdate-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.

RequestWhat 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 id and company_id) returns a 400 that lists the fields the table accepts. Records are always created in the key's own company.

  • custom and a register row's data are 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. warnings carries anything else you should know.

  • GET /api/v1/tables and GET /api/v1/tables/{table}/fields include a writes block 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

TableCreateUpdateWritable fields
complaintsYesYesstatus, 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
ncrsYesYestitle, 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
incidentsYesYesstatus, 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_recordsYes (needs training_name)Yesuser_email, staff_name, training_name, provider, completed_date, expiry_date, notes
production_runsYesYesrun_date, product_id, product_text, qty, status, asset_ids, notes
pest_visitsYesYesvisit_date, visit_type, contractor, technician, summary, recommendations, checks
assetsYes (needs name)Yesname, custom_asset_number, status, item_type, location, serial_number, year_of_manufacture, key_parts, maintenance_notes, severity, likelihood, risk_score, supplier_ids
job_sheetsYesYesstatus, sheet_type, details, asset_id, supplier_id, scheduled_date, due_date, assigned_email, completed_date, completed_by, completed_notes, invasive
spare_partsYes (needs name)Yesname, part_no, stock_on_hand, min_stock, max_stock, order_qty, lead_time_days, supplier_id, notes
suppliersYes (needs business_name)Yesbusiness_name, supplier_type, email, phone, address, notes, staff_email, custom
pm_schedulesNoYesfrequency, notes, last_maintenance_date, default_supplier_id
register_entriesYes (needs register_id, data)Yesregister_id, data, attachments

Forms

RequestWhat it does
GET /api/v1/formsYour 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}/submissionsSubmit 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

StatusMeaning
400Something in the request needs fixing; the message says what.
401No key, or the key is wrong or revoked.
403The 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).
404No such table, or no record with that id in your company.
405That table can't be created or updated through the API.
409The record can't change in its current state (for example it is archived); the message says what to do.
500Something 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 Authorization and value Bearer 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 header Authorization with Bearer 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.

v13.84