Home/Forms

Forms API

Retrieve and manage forms in your Minform account.

Endpoint Overview

The forms API allows you to retrieve a list of forms from your Minform account. This is typically used as a trigger within Pipedream to allow users to select which form they want to work with.

List Forms

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

Retrieve a list of forms that the authenticated user has access to.

Parameters

Parameter	Type	Required	Description
`page`	Integer	No	Page number for pagination (0-based). Default: 0
`limit`	Integer	No	Number of forms to return per page. Default: 25

Headers

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

Response

The response is an array of form objects with the following properties:

Property	Type	Description
`id`	String	Unique identifier for the form (form slug)
`name`	String	Display name of the form
`space_id`	String	ID of the space the form belongs to
`last_modified`	String (ISO 8601)	Timestamp when the form was last modified
`response_count`	Integer	Number of submissions received for this form

Response Headers

Header	Description
`X-Total-Count`	Total number of forms available
`Link`	Pagination links (included if there are more pages)

Example Response

[
  {
    "id": "contact-form",
    "name": "Contact Form",
    "space_id": "workspace-123",
    "last_modified": "2023-08-01T12:00:00Z",
    "response_count": 42
  },
  {
    "id": "feedback-survey",
    "name": "Feedback Survey",
    "space_id": "workspace-123",
    "last_modified": "2023-07-15T09:30:00Z",
    "response_count": 18
  }
]

Note: This endpoint requires the read:forms scope.

Error Responses

The API may return the following error responses:

Status Code	Error	Description
400	Bad Request	The request was invalid or could not be understood.
401	Unauthorized	Authentication failed or was not provided.
403	Forbidden	The authenticated user doesn't have permission.
500	Server Error	An error occurred on the server.