Home/Form Submissions

Form Submissions API

Retrieve form submissions from Minform.

Endpoint Overview

The form submissions API allows you to retrieve form submissions for a specific form. This endpoint is primarily used for testing and sample data within Pipedream.

Get Form Submissions

GEThttps://minform.io/api/pipedream/results

Retrieve form submissions for a specific form identified by its slug.

Parameters

Parameter	Type	Required	Description
`slug`	String	Yes	The slug identifier of the form

Headers

Header	Required	Description
`Authorization`	Yes	Bearer token for authentication. Format: `Bearer <token>`

Response

The response is an array of submission objects with the following structure:

[
  {
    "id": "submission_123456",
    "createdAt": "2023-08-01T12:00:00Z",
    "formId": "contact-form",
    "formName": "Contact Form",
    "fields": {
      "name": { 
        "value": "John Doe", 
        "label": "Name", 
        "type": "inputShort" 
      },
      "email": { 
        "value": "john@example.com", 
        "label": "Email", 
        "type": "inputEmail" 
      },
      "message": { 
        "value": "Hello! I'd like more information.", 
        "label": "Message", 
        "type": "inputLong" 
      }
    }
  },
  {
    "id": "submission_123457",
    "createdAt": "2023-08-02T15:30:00Z",
    "formId": "contact-form",
    "formName": "Contact Form",
    "fields": {
      "name": { 
        "value": "Jane Smith", 
        "label": "Name", 
        "type": "inputShort" 
      },
      "email": { 
        "value": "jane@example.com", 
        "label": "Email", 
        "type": "inputEmail" 
      },
      "message": { 
        "value": "Please contact me about your services.", 
        "label": "Message", 
        "type": "inputLong" 
      }
    }
  }
]

Submission Object Structure

Property	Type	Description
`id`	String	Unique identifier for the submission
`createdAt`	String (ISO 8601)	Timestamp when the submission was created
`formId`	String	The slug identifier of the form
`formName`	String	The display name of the form
`fields`	Object	An object containing all form field submissions

Field Object Structure

Property	Type	Description
`value`	String, Array, or Object	The submitted value for the field
`label`	String	The display label of the field
`type`	String	The type of the field (e.g., inputShort, inputEmail, inputLong)

Note: This endpoint requires the read:submissions scope.

Field Types

Minform supports various field types that may appear in the form submissions. Each field type has a specific format for its value:

Field Type	Value Format	Example
`inputShort`	String	`"John Doe"`
`inputLong`	String	`"Longer text content..."`
`inputEmail`	String	`"user@example.com"`
`inputNumber`	String (numeric)	`"42"`
`inputSelect`	String	`"Option A"`
`inputMultiselect`	Array of Strings	`["Option A", "Option B"]`
`inputDate`	String (ISO 8601)	`"2023-08-01"`

Error Responses

The API may return the following error responses:

Status Code	Error	Description
400	Bad Request	The request was invalid (e.g., missing required slug parameter)
401	Unauthorized	Authentication failed or was not provided
403	Forbidden	The authenticated user doesn't have permission to access the form
404	Not Found	The specified form was not found
500	Server Error	An error occurred on the server