Fillout | Help Center

Get all submissions

curl --request GET \
  --url https://api.fillout.com/v1/api/forms/{formId}/submissions \
  --header 'Authorization: Bearer <token>'

{
  "responses": [
    {
      "submissionId": "<string>",
      "submissionTime": "2023-11-07T05:31:56Z",
      "questions": [
        {
          "id": "<string>",
          "name": "<string>",
          "type": "<string>",
          "value": "<unknown>"
        }
      ],
      "lastUpdatedAt": "2023-11-07T05:31:56Z",
      "calculations": [
        {
          "id": "<string>",
          "name": "<string>",
          "type": "number",
          "value": "<string>"
        }
      ],
      "urlParameters": [
        {
          "id": "<string>",
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "scheduling": [
        {
          "id": "<string>",
          "name": "<string>",
          "value": {
            "fullName": "<string>",
            "email": "[email protected]",
            "timezone": "<string>",
            "eventStartTime": "2023-11-07T05:31:56Z",
            "eventEndTime": "2023-11-07T05:31:56Z",
            "eventId": "<string>",
            "eventUrl": "<string>",
            "rescheduleOrCancelUrl": "<string>",
            "userId": 123,
            "scheduledUserEmail": "[email protected]",
            "meetingNotes": "<string>"
          }
        }
      ],
      "payments": [
        {
          "id": "<string>",
          "name": "<string>",
          "value": {
            "paymentId": "<string>",
            "stripeCustomerId": "<string>",
            "stripeCustomerUrl": "<string>",
            "stripePaymentUrl": "<string>",
            "totalAmount": 123,
            "currency": "<string>",
            "email": "[email protected]",
            "discountCode": "<string>",
            "status": "<string>",
            "stripeSubscriptionId": "<string>"
          }
        }
      ],
      "quiz": {
        "score": 123,
        "maxScore": 123
      },
      "login": {
        "email": "[email protected]"
      }
    }
  ],
  "totalResponses": 123,
  "pageCount": 123
}

GET

forms

{formId}

submissions

Get all submissions

curl --request GET \
  --url https://api.fillout.com/v1/api/forms/{formId}/submissions \
  --header 'Authorization: Bearer <token>'

{
  "responses": [
    {
      "submissionId": "<string>",
      "submissionTime": "2023-11-07T05:31:56Z",
      "questions": [
        {
          "id": "<string>",
          "name": "<string>",
          "type": "<string>",
          "value": "<unknown>"
        }
      ],
      "lastUpdatedAt": "2023-11-07T05:31:56Z",
      "calculations": [
        {
          "id": "<string>",
          "name": "<string>",
          "type": "number",
          "value": "<string>"
        }
      ],
      "urlParameters": [
        {
          "id": "<string>",
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "scheduling": [
        {
          "id": "<string>",
          "name": "<string>",
          "value": {
            "fullName": "<string>",
            "email": "[email protected]",
            "timezone": "<string>",
            "eventStartTime": "2023-11-07T05:31:56Z",
            "eventEndTime": "2023-11-07T05:31:56Z",
            "eventId": "<string>",
            "eventUrl": "<string>",
            "rescheduleOrCancelUrl": "<string>",
            "userId": 123,
            "scheduledUserEmail": "[email protected]",
            "meetingNotes": "<string>"
          }
        }
      ],
      "payments": [
        {
          "id": "<string>",
          "name": "<string>",
          "value": {
            "paymentId": "<string>",
            "stripeCustomerId": "<string>",
            "stripeCustomerUrl": "<string>",
            "stripePaymentUrl": "<string>",
            "totalAmount": 123,
            "currency": "<string>",
            "email": "[email protected]",
            "discountCode": "<string>",
            "status": "<string>",
            "stripeSubscriptionId": "<string>"
          }
        }
      ],
      "quiz": {
        "score": 123,
        "maxScore": 123
      },
      "login": {
        "email": "[email protected]"
      }
    }
  ],
  "totalResponses": 123,
  "pageCount": 123
}

New field types are added regularly. Your application should discard fields with unknown types.

Authorizations

Authorization

string

header

required

Enter your Fillout API key. Format: Bearer <api_key>

Path Parameters

formId

string

required

The public identifier of the form

Query Parameters

limit

integer

default:50

The maximum number of submissions to retrieve per request

Required range: 1 <= x <= 150

afterDate

string<date-time>

A date string to filter submissions submitted after this date

beforeDate

string<date-time>

A date string to filter submissions submitted before this date

offset

integer

default:0

The starting position from which to fetch the submissions

status

enum<string>

Pass 'in_progress' to get unfinished submissions. By default, only 'finished' submissions are returned

Available options:

finished,

in_progress

includeEditLink

boolean

Pass true to include a link to edit the submission as 'editLink'

includePreview

boolean

Pass true to include preview responses

sort

enum<string>

default:asc

Sort order for the submissions

Available options:

asc,

desc

string

Filter for submissions containing a string of text

Response

200 - application/json

List of submissions

responses

object[]

required

List of submissions

Show child attributes

responses.submissionId

string

required

Unique identifier for the submission

responses.submissionTime

string<date-time>

required

When the submission was made

responses.questions

object[]

required

List of question responses

Show child attributes

responses.questions.id

string

required

Identifier of the question

responses.questions.name

string

required

The question text

responses.questions.type

string

required

The type of the question

responses.questions.value

any

required

The response value

responses.lastUpdatedAt

string<date-time>

When the submission was last updated

responses.calculations

object[]

List of calculation responses

Show child attributes

responses.calculations.id

string

required

Identifier of the calculation

responses.calculations.name

string

required

Name of the calculation

responses.calculations.type

enum<string>

required

Type of the calculation

Available options:

number,

text,

duration

responses.calculations.value

string

required

The calculated value

responses.urlParameters

object[]

List of URL parameter values

Show child attributes

responses.urlParameters.id

string

required

Identifier of the URL parameter

responses.urlParameters.name

string

required

Name of the URL parameter

responses.urlParameters.value

string

required

Value of the URL parameter

responses.scheduling

object[]

List of scheduling responses (if using Fillout Scheduling)

Show child attributes

responses.scheduling.id

string

required

Identifier of the scheduling field

responses.scheduling.name

string

required

Name of the scheduling field

responses.scheduling.value

object

required

Scheduling details

Show child attributes

responses.scheduling.value.fullName

string

required

Full name of the person booking

responses.scheduling.value.email

string<email>

required

Email of the person booking

responses.scheduling.value.timezone

string

required

Timezone for the meeting

responses.scheduling.value.eventStartTime

string<date-time>

required

Start time of the event

responses.scheduling.value.eventEndTime

string<date-time>

required

End time of the event

responses.scheduling.value.eventId

string

Calendar event ID

responses.scheduling.value.eventUrl

string<uri>

URL to the calendar event

responses.scheduling.value.rescheduleOrCancelUrl

string<uri>

URL to reschedule or cancel the event

responses.scheduling.value.userId

integer

User ID (optional)

responses.scheduling.value.scheduledUserEmail

string<email>

Email of the scheduled user (optional)

responses.scheduling.value.meetingNotes

string

Meeting notes (optional)

responses.payments

object[]

List of payment responses (if using Fillout Payments)

Show child attributes

responses.payments.id

string

required

Identifier of the payment field

responses.payments.name

string

required

Name of the payment field

responses.payments.value

object

required

Payment details

Show child attributes

responses.payments.value.paymentId

string

required

Stripe payment ID

responses.payments.value.stripeCustomerId

string

Stripe customer ID (optional)

responses.payments.value.stripeCustomerUrl

string<uri>

URL to Stripe customer dashboard (optional)

responses.payments.value.stripePaymentUrl

string<uri>

URL to Stripe payment dashboard (optional)

responses.payments.value.totalAmount

integer

Total amount in cents (optional)

responses.payments.value.currency

string

Currency code (optional)

responses.payments.value.email

string<email>

Customer email (optional)

responses.payments.value.discountCode

string

Discount code used (optional)

responses.payments.value.status

string

Payment status (optional)

responses.payments.value.stripeSubscriptionId

string

Stripe subscription ID (optional)

responses.quiz

object

Quiz results (if form is configured as quiz)

Show child attributes

responses.quiz.score

integer

required

Quiz score

responses.quiz.maxScore

integer

required

Maximum possible score

Show child attributes

Verified email address

totalResponses

integer

required

Total number of submissions matching given parameters

pageCount

integer

required

Total number of pages of submissions based on provided limit

Get form metadata Get submission by id

⌘I

Getting Started

Styling & Branding

Integrations

Logic

Sharing & Embedding

Results

Fillout Scheduling

Fillout Workflows

Conversion Kit

Guides

API Reference

Advanced

Account

Security & Legal

Get all submissions

Authorizations

Path Parameters

Query Parameters

Response