Fillout

https://www.fillout.com/help
Admin
Fillout is a form builder platform that enables users to create powerful forms, surveys, and quizzes...
Tokens:79,880
Snippets:1,489
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Client Portal Setup Guide Prompt

Source: https://www.fillout.com/help/database/build-apps

Use this prompt to build a secure client portal with project status and invoice tracking.

```text
Build a client portal for external clients to view project status,
files, invoices, and next steps. Add login so each client only sees
their own projects.
```

--------------------------------

### Employee Onboarding Guide Prompt

Source: https://www.fillout.com/help/database/build-apps

Use this prompt to generate an onboarding application for tracking new hire tasks and status.

```text
Build an employee onboarding guide for new hires and HR managers.
Track employees, onboarding tasks, owners, due dates, and completion
status. Include a new hire view, an HR admin view, and task reminders.
```

--------------------------------

### Approval Workflow Example Prompt

Source: https://www.fillout.com/help/database/build-apps

Use this prompt to create an approval workflow for purchase requests with notification and history tracking.

```text
Build an approval workflow for purchase requests. Track request, vendor,
amount, department, approver, and status fields. Include submitter and
approver views, email notifications, and an approval history.
```

--------------------------------

### GET https://build.fillout.com/authorize/oauth

Source: https://www.fillout.com/help/oauth-applications

Initiates the OAuth process by redirecting the user to the authorization endpoint.

```APIDOC
## GET https://build.fillout.com/authorize/oauth

### Description
Initiate the OAuth process by sending users to this endpoint.

### Method
GET

### Endpoint
https://build.fillout.com/authorize/oauth

### Parameters
#### Query Parameters
- **client_id** (string) - Required - The client ID of your app.
- **redirect_uri** (string) - Required - The URL to redirect to after access is granted.
- **state** (string) - Optional - A string used to retain state when redirecting back to your app.
```

--------------------------------

### Create Submissions via API

Source: https://www.fillout.com/help/api-reference/create-submissions

Use these examples to send form submission data to the Fillout API endpoint.

```bash
curl --request POST \
  --url https://api.fillout.com/v1/api/forms/{formId}/submissions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "submissions": [
    {
      "questions": [
        {
          "id": "<string>",
          "value": "<unknown>"
        }
      ],
      "urlParameters": [
        {
          "id": "<string>",
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "submissionTime": "2023-11-07T05:31:56Z",
      "lastUpdatedAt": "2023-11-07T05:31:56Z",
      "scheduling": [
        {
          "id": "<string>",
          "value": {
            "fullName": "<string>",
            "email": "jsmith@example.com",
            "eventStartTime": "2023-11-07T05:31:56Z",
            "eventEndTime": "2023-11-07T05:31:56Z",
            "timezone": "<string>",
            "userId": 123,
            "scheduledUserEmail": "jsmith@example.com",
            "eventId": "<string>",
            "eventUrl": "<string>",
            "rescheduleOrCancelUrl": "<string>",
            "meetingNotes": "<string>"
          }
        }
      ],
      "payments": [
        {
          "id": "<string>",
          "value": {
            "paymentId": "<string>",
            "stripeCustomerId": "<string>",
            "stripeCustomerUrl": "<string>",
            "stripePaymentUrl": "<string>",
            "totalAmount": 123,
            "currency": "<string>",
            "email": "jsmith@example.com",
            "status": "<string>",
            "stripeSubscriptionId": "<string>"
          }
        }
      ]
    }
  ]
}
'
```

```python
import requests  
  
url = "https://api.fillout.com/v1/api/forms/{formId}/submissions"  
  
payload = { "submissions": [  
        {  
            "questions": [  
                {  
                    "id": "<string>",  
                    "value": "<unknown>"  
                }  
            ],  
            "urlParameters": [  
                {  
                    "id": "<string>",  
                    "name": "<string>",  
                    "value": "<string>"  
                }  
            ],  
            "submissionTime": "2023-11-07T05:31:56Z",  
            "lastUpdatedAt": "2023-11-07T05:31:56Z",  
            "scheduling": [  
                {  
                    "id": "<string>",  
                    "value": {  
                        "fullName": "<string>",  
                        "email": "jsmith@example.com",  
                        "eventStartTime": "2023-11-07T05:31:56Z",  
                        "eventEndTime": "2023-11-07T05:31:56Z",  
                        "timezone": "<string>",  
                        "userId": 123,  
                        "scheduledUserEmail": "jsmith@example.com",  
                        "eventId": "<string>",  
                        "eventUrl": "<string>",  
                        "rescheduleOrCancelUrl": "<string>",  
                        "meetingNotes": "<string>"  
                    }  
                }  
            ],  
            "payments": [  
                {  
                    "id": "<string>",  
                    "value": {  
                        "paymentId": "<string>",  
                        "stripeCustomerId": "<string>",  
                        "stripeCustomerUrl": "<string>",  
                        "stripePaymentUrl": "<string>",  
                        "totalAmount": 123,  
                        "currency": "<string>",  
                        "email": "jsmith@example.com",  
                        "status": "<string>",  
                        "stripeSubscriptionId": "<string>"  
                    }  
                }  
            ]  
        }  
    ] }  
headers = {  
    "Authorization": "Bearer <token>",  
    "Content-Type": "application/json"  
}  
  
response = requests.post(url, json=payload, headers=headers)  
  
print(response.text)
```

--------------------------------

### Create Submission cURL Request

Source: https://www.fillout.com/help/api-reference/create-submissions

Example cURL command to create a new submission for a specific form ID, requiring an authorization token.

```bash
curl --request POST \
  --url https://api.fillout.com/v1/api/forms/{formId}/submissions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "submissions": [
    {
      "questions": [
        {
          "id": "<string>",
          "value": "<unknown>"
        }
      ],
      "urlParameters": [
        {
          "id": "<string>",
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "submissionTime": "2023-11-07T05:31:56Z",
      "lastUpdatedAt": "2023-11-07T05:31:56Z",
      "scheduling": [
        {
          "id": "<string>",
          "value": {
            "fullName": "<string>",
            "email": "jsmith@example.com",
            "eventStartTime": "2023-11-07T05:31:56Z",
            "eventEndTime": "2023-11-07T05:31:56Z",
            "timezone": "<string>",
            "userId": 123,
            "scheduledUserEmail": "jsmith@example.com",
            "eventId": "<string>",
            "eventUrl": "<string>",
            "rescheduleOrCancelUrl": "<string>",
            "meetingNotes": "<string>"
          }
        }
      ],
      "payments": [
        {
          "id": "<string>",
          "value": {
            "paymentId": "<string>",
            "stripeCustomerId": "<string>",
            "stripeCustomerUrl": "<string>",
            "stripePaymentUrl": "<string>",
            "totalAmount": 123,
            "currency": "<string>",
            "email": "jsmith@example.com",
            "status": "<string>",
            "stripeSubscriptionId": "<string>"
          }
        }
      ]
    }
  ]
}
'
```

--------------------------------

### Get All Forms - OpenAPI Specification

Source: https://www.fillout.com/help/api-reference/get-forms

This OpenAPI 3.0.1 specification defines the GET /forms endpoint. It outlines the request method, path, authentication requirements, and the structure of the response, including the schema for FormSummary.

```yaml
GET /forms
openapi: 3.0.1
info:
  title: Fillout REST API
  description: A REST API for managing forms, submissions, and webhooks in Fillout
  version: 1.0.0
servers:
  - url: https://api.fillout.com/v1/api
    description: US server
  - url: https://eu-api.fillout.com/v1/api
    description: EU server
security:
  - bearerAuth: []
paths:
  /forms:
    get:
      summary: Get all forms
      description: Returns a list of all your forms
      operationId: getForms
      responses:
        '200':
          description: List of forms
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FormSummary'
components:
  schemas:
    FormSummary:
      type: object
      properties:
        name:
          type: string
          description: The name of the form
        formId:
          type: string
          description: The public identifier of the form
      required:
        - name
        - formId
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Enter your [Fillout API
        key](https://build.fillout.com/home/settings/developer). Format: Bearer
        <api_key>
```

--------------------------------

### Get Submission by ID

Source: https://www.fillout.com/help/api-reference/get-submission-by-id

Returns a single submission by its ID.

```APIDOC
## Get Submission by ID

### Description
Returns a single submission by its ID.

### Method
GET

### Endpoint
`/submissions/{submissionId}`

### Parameters
#### Path Parameters
- **submissionId** (string) - Required - The unique identifier of the submission to retrieve.

### Response
#### Success Response (200)
- **submission** (object) - The submission object containing all details.

#### Response Example
```json
{
  "submission": {
    "id": "sub_abc123",
    "formId": "form_xyz789",
    "createdAt": "2023-10-27T10:00:00Z",
    "fields": [
      {
        "id": "field_1",
        "name": "Email",
        "value": "test@example.com"
      }
    ],
    "metadata": {
      "userAgent": "Mozilla/5.0",
      "referer": "https://example.com"
    }
  }
}
```
```

--------------------------------

### Dashboard Builder Tutorial Prompt

Source: https://www.fillout.com/help/database/build-apps

Use this prompt to generate a business dashboard for tracking performance metrics and pipeline status.

```text
Build a business dashboard for team leads. Show revenue, pipeline
status, owner performance, and weekly changes. Include filters by region
and owner.
```

--------------------------------

### Create Submissions with Go

Source: https://www.fillout.com/help/api-reference/create-submissions

Uses the standard net/http library to perform a POST request to the submissions endpoint.

```go
package main  
  
import (  
	"fmt"  
	"strings"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.fillout.com/v1/api/forms/{formId}/submissions"  
  
	payload := strings.NewReader("{\n  \"submissions\": [\n    {\n      \"questions\": [\n        {\n          \"id\": \"<string>\",\n          \"value\": \"<unknown>\"\n        }\n      ],\n      \"urlParameters\": [\n        {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"submissionTime\": \"2023-11-07T05:31:56Z\",\n      \"lastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n      \"scheduling\": [\n        {\n          \"id\": \"<string>\",\n          \"value\": {\n            \"fullName\": \"<string>\",\n            \"email\": \"jsmith@example.com\",\n            \"eventStartTime\": \"2023-11-07T05:31:56Z\",\n            \"eventEndTime\": \"2023-11-07T05:31:56Z\",\n            \"timezone\": \"<string>\",\n            \"userId\": 123,\n            \"scheduledUserEmail\": \"jsmith@example.com\",\n            \"eventId\": \"<string>\",\n            \"eventUrl\": \"<string>\",\n            \"rescheduleOrCancelUrl\": \"<string>\",\n            \"meetingNotes\": \"<string>\"\n          }\n        }\n      ],\n      \"payments\": [\n        {\n          \"id\": \"<string>\",\n          \"value\": {\n            \"paymentId\": \"<string>\",\n            \"stripeCustomerId\": \"<string>\",\n            \"stripeCustomerUrl\": \"<string>\",\n            \"stripePaymentUrl\": \"<string>\",\n            \"totalAmount\": 123,\n            \"currency\": \"<string>\",\n            \"email\": \"jsmith@example.com\",\n            \"status\": \"<string>\",\n            \"stripeSubscriptionId\": \"<string>\"\n          }\n        }\n      ]\n    }\n  ]\n}")  
  
	req, _ := http.NewRequest("POST", url, payload)  
  
	req.Header.Add("Authorization", "Bearer <token>")  
	req.Header.Add("Content-Type", "application/json")  
  
	res, _ := http.DefaultClient.Do(req)  
  
	defer res.Body.Close()  
	body, _ := io.ReadAll(res.Body)  
  
	fmt.Println(string(body))  
  
}
```

--------------------------------

### Get All Submissions

Source: https://www.fillout.com/help/api-reference/get-all-submissions

Retrieves a list of all submissions for a given form. You can filter, sort, and paginate the results.

```APIDOC
## GET /forms/{formId}/submissions

### Description
Returns a list of all submissions for a given form.

### Method
GET

### Endpoint
/forms/{formId}/submissions

### Parameters
#### Path Parameters
- **formId** (string) - Required - The public identifier of the form

#### Query Parameters
- **limit** (integer) - Optional - The maximum number of submissions to retrieve per request. Default: 50. Minimum: 1, Maximum: 150.
- **afterDate** (string) - Optional - A date string to filter submissions submitted after this date. Format: date-time.
- **beforeDate** (string) - Optional - A date string to filter submissions submitted before this date. Format: date-time.
- **offset** (integer) - Optional - The starting position from which to fetch the submissions. Default: 0.
- **status** (string) - Optional - Pass 'in_progress' to get unfinished submissions. By default, only 'finished' submissions are returned. Enum: finished, in_progress.
- **includeEditLink** (boolean) - Optional - Pass true to include a link to edit the submission as 'editLink'.
- **includePreview** (boolean) - Optional - Pass true to include preview responses.
- **sort** (string) - Optional - Sort order for the submissions. Default: asc. Enum: asc, desc.
- **search** (string) - Optional - Filter for submissions containing a string of text.

### Responses
#### Success Response (200)
- **responses** (array) - List of submissions.
- **totalResponses** (integer) - Total number of submissions matching given parameters.
- **pageCount** (integer) - Total number of pages of submissions based on provided limit.

#### Response Example
{
  "responses": [
    {
      "submissionId": "sub_12345",
      "submissionTime": "2023-10-27T10:00:00Z",
      "lastUpdatedAt": "2023-10-27T10:05:00Z",
      "questions": [
        {
          "questionId": "q_abcde",
          "label": "Your Name",
          "type": "short_text",
          "answer": "John Doe"
        }
      ],
      "calculations": [],
      "urlParameters": [],
      "scheduling": [],
      "payments": [],
      "quiz": null,
      "login": null
    }
  ],
  "totalResponses": 1,
  "pageCount": 1
}
```

--------------------------------

### Inventory Management Template Prompt

Source: https://www.fillout.com/help/database/build-apps

Use this prompt to create an inventory management system with stock tracking and alerts.

```text
Build an inventory management app for the operations team. Track items,
suppliers, stock counts, locations, and reorder thresholds. Include a
dashboard, low-stock alerts, item update forms, and manager-only editing.
```

--------------------------------

### Embed YouTube Video Player

Source: https://www.fillout.com/help/fillout

An iframe implementation for embedding the Fillout basics tutorial video.

```html
<iframe src="https://www.youtube.com/embed/ZhdKHlztgsk" title="YouTube video player" frameborder="0" className="w-full aspect-video rounded-xl" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowFullScreen />
```

--------------------------------

### Get Form Metadata

Source: https://www.fillout.com/help/api-reference/get-form-metadata

Fetches the metadata for a given form ID. This includes all questions, calculations, URL parameters, and scheduling/payment configurations.

```APIDOC
## GET /forms/{formId}

### Description
Given the formId, returns all the questions in that form and other metadata.

### Method
GET

### Endpoint
/forms/{formId}

#### Path Parameters
- **formId** (string) - Required - The public ID of your form

#### Response
##### Success Response (200)
- **id** (string) - The public identifier of the form
- **name** (string) - The name of the form
- **questions** (array) - List of questions in the form
- **calculations** (array) - List of calculations in the form
- **urlParameters** (array) - List of URL parameters
- **scheduling** (array) - List of scheduling fields (if using Fillout Scheduling)
- **payments** (array) - List of payment fields (if using Fillout Payments)
- **quiz** (object) - Quiz configuration (only defined if quiz mode is enabled)

##### Response Example
{
  "example": "{\"id\": \"form_abc123\", \"name\": \"Customer Feedback Form\", \"questions\": [{\"id\": \"q1\", \"name\": \"What is your name?\", \"type\": \"ShortAnswer\"}], \"calculations\": [], \"urlParameters\": [], \"scheduling\": [], \"payments\": [], \"quiz\": null}"
}
```

--------------------------------

### Create Submission with Net::HTTP (Ruby)

Source: https://www.fillout.com/help/api-reference/create-submissions

Uses the standard Ruby Net::HTTP library to perform a POST request.

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.fillout.com/v1/api/forms/{formId}/submissions")  
  
http = Net::HTTP.new(url.host, url.port)  
http.use_ssl = true  
  
request = Net::HTTP::Post.new(url)  
request["Authorization"] = 'Bearer <token>'  
request["Content-Type"] = 'application/json'  
request.body = "{\n  \"submissions\": [\n    {\n      \"questions\": [\n        {\n          \"id\": \"<string>\",\n          \"value\": \"<unknown>\"\n        }\n      ],\n      \"urlParameters\": [\n        {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"submissionTime\": \"2023-11-07T05:31:56Z\",\n      \"lastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n      \"scheduling\": [\n        {\n          \"id\": \"<string>\",\n          \"value\": {\n            \"fullName\": \"<string>\",\n            \"email\": \"jsmith@example.com\",\n            \"eventStartTime\": \"2023-11-07T05:31:56Z\",\n            \"eventEndTime\": \"2023-11-07T05:31:56Z\",\n            \"timezone\": \"<string>\",\n            \"userId\": 123,\n            \"scheduledUserEmail\": \"jsmith@example.com\",\n            \"eventId\": \"<string>\",\n            \"eventUrl\": \"<string>\",\n            \"rescheduleOrCancelUrl\": \"<string>\",\n            \"meetingNotes\": \"<string>\"\n          }\n        }\n      ],\n      \"payments\": [\n        {\n          \"id\": \"<string>\",\n          \"value\": {\n            \"paymentId\": \"<string>\",\n            \"stripeCustomerId\": \"<string>\",\n            \"stripeCustomerUrl\": \"<string>\",\n            \"stripePaymentUrl\": \"<string>\",\n            \"totalAmount\": 123,\n            \"currency\": \"<string>\",\n            \"email\": \"jsmith@example.com\",\n            \"status\": \"<string>\",\n            \"stripeSubscriptionId\": \"<string>\"\n          }\n        }\n      ]\n    }\n  ]\n}"  
  
response = http.request(request)  
puts response.read_body
```
Tokens:
Raw