Skip to main content

API Details - Forms

Written by Support Superfood

Superfood API — Getting Started

The Superfood API lets you connect external applications to your forms data — retrieve form schemas, list active forms, and submit completed forms programmatically.

Base URL: https://app.superfoodapps.com/api/v1


Step 1 — Generate an API Key

  1. Log in to the Superfood Portal

  2. Go to My Profile (top of the left sidebar under Overview)

  3. Scroll to API Keys

  4. Enter a name for your key (e.g. "Mobile App") and click Generate Key

  5. Copy the key immediately — it is only shown once

Your key will look like: sf_live_a1b2c3d4e5f6...


Step 2 — Authenticate your requests

Include your key in every request using either header:

Authorization: Bearer sf_live_your_key_here

or

X-API-Key: sf_live_your_key_here

Endpoints

List forms

GET /api/v1/forms

Returns all active forms available to your account.

{

"forms": [

{

"id": "F01",

"name": "Delivery Receipts Form",

"category": "Receiving",

"description": "Record all incoming deliveries...",

"frequency": "daily",

"section_count": 2,

"field_count": 12,

"source": "registry"

}

],

"total": 1

}


Get a form schema

GET /api/v1/forms/:id

Returns the full form definition including all sections and fields. Use this to render the form in your application.

GET /api/v1/forms/F01

GET /api/v1/forms/cf-your-custom-form-id

Field types: text, textarea, number, date, time, select, radio, checkbox, email, phone, signature, table, staff-select, product-select


Submit a form

POST /api/v1/forms/:id/submissions

{

"submitted_by": "Jane Smith",

"fields": {

"date": "2026-05-28",

"supplier_name": "Acme Co",

"temperature": "4.2",

"condition": "Good"

}

}

Response:

{

"submission": {

"id": "uuid",

"submitted_at": "2026-05-28T09:14:00Z"

}

}

Submissions enter the QA queue for sign-off before appearing as completed.


Managing API Keys

Keys can be revoked at any time from My Profile → API Keys. Revoking a key immediately blocks all requests using it.

Each key is scoped to your company — it can only access your company's forms and submissions.


Error Responses

Status

Meaning

401

Missing or invalid API key

403

Key does not have access to this resource

404

Form or submission not found

400

Invalid request body

500

Server error — contact support


Need help?

Contact us at [email protected] and include your key prefix (the first 12 characters — never share the full key).

Did this answer your question?