Power Up Your Backend

Formeezy Submissions API

Use the Formeezy API to programmatically query and filter your form submission data. Create a key and start making requests in minutes.

Getting Started

Making Authorized API Requests
Learn how to make authorized requests to the Formeezy API using your generated key.
Formeezy API Overview
Learn everything you need to know to start using the Formeezy API to access your account submissions data.
Submission Form Examples
View real-life examples that utilize the Formeezy API to submit and store submissions.
Generating Your API Key
Learn how to get started with the Formeezy API by generating your account API key.

API DOCS

Submit A Form

POST/v1/forms/{FORM_ID}/submissions

Using this submission API endpoint, you can send a POST request along with a payload to a specific form that will then be available in your Submissions Dashboard, as well as trigger any integrations. This endpoint does not require your X-API-KEY as it is the default public facing endpoint utilized to store submissions on your account.

Parameters

Request

https://formeezy.com/api/v1/forms/{FORM_ID}/submissions

Get your free API key →

Request Body

{
    "email": "hello@example.com",
    "message": "Hi there! Just testing this form."
}

The form request body in FormData or JSON format.

Request Headers

X-API-Key

optional

Your unique key for making requests.

{'X-API-KEY': '{YOUR_API_KEY}'}

X-URL

optional

Manually add a referer source URL to your form submission.

{'X-URL': 'https://example.com/contact-us'}

Response Attributes

redirect

string

The redirect URL needed to complete next steps or continue to thank-you page. Possible URLs include Stripe Checkout, reCAPTCHA, default thank you page, and custom thank you page. This redirect be ignored if you are not using one-click reCAPTCHA or Stripe, and would prefer to manage success/error states manually.

Error Response Object

{
    "status": 404,
    "message": "Not Found: This form has been deleted, or does not exist. Please check your form URL.",
    "redirect" : "https://formeezy.com/app/error?status=400&message=This+is+an+error+message."
}

Error Response Attributes

status

number

The HTTP status code of the request.

message

string

The error message of the request.

redirect

number

The default error URL provided.

Response Object

{
  redirect: "https://formeezy.com/app/thanks?success=true"
}

Endpoints

POST / Submit A Form
GET / All Submissions
GET / Submissions By Form
GET / Submission By ID

API DOCS

All Submissions

GET/v1/submissions

Using this submission API endpoint, you can return a list of submissions using various filters that are similar to the functionality available in your Formeezy submissions dashboard.

Parameters

Request

https://formeezy.com/api/v1/submissions

Get your free API key →

Request Headers

X-API-Key

required

Your unique key for making requests.

{'X-API-KEY': '{YOUR_API_KEY}'}

Response Attributes

submissions

array

Array of submissions matching this query.

id

string

The ID of the submission.

created_at

date

The date this submission was created.

is_spam

boolean

The current spam status of this submission.

is_read

boolean

The current read/unread status.

form_id

string

The ID of the form this submission was sent to.

body

object

The body of your form submission.

total_submissions

number

The total number of submissions for this search.

per_page

number

The number of results per page.

page

number

The current page of results.

total_pages

number

The number of pages total for this query.

more_results

boolean

Whether there are more results or not.

Response Object

{
  "submissions": [
    {
      "id": "987654321",
      "created_at": "2021-02-04T22:52:32.098Z",
      "is_spam": false,
      "is_read": true,
      "form_id": "123456789",
      "body": {
        "email": "hello@example.com",
        "message": "Hi there! Just testing this form.",
        "form_name": "Contact Form",
        "referer": "https://example.com/contact"
      }
    },
  ],
  "total_submissions": 1,
  "per_page": 100,
  "page": 1,
  "total_pages": 1,
  "more_results": false
}

Endpoints

POST / Submit A Form
GET / All Submissions
GET / Submissions By Form
GET / Submission By ID

API DOCS

Submissions By Form

GET/v1/forms/{FORM_ID}/submissions

Using this submission API endpoint, you can return a list of submissions for a specific form using various filters that are similar to the functionality available in your Formeezy forms dashboard.

Parameters

Request

https://formeezy.com/api/v1/forms/{FORM_ID}/submissions

Get your free API key →

Request Headers

X-API-Key

required

Your unique key for making requests.

{'X-API-KEY': '{YOUR_API_KEY}'}

Response Attributes

submissions

array

Array of submissions matching this query.

id

string

The ID of the submission.

created_at

date

The date this submission was created.

is_spam

boolean

The current spam status of this submission.

is_read

boolean

The current read/unread status.

form_id

string

The ID of the form this submission was sent to.

body

object

The body of your form submission.

total_submissions

number

The total number of submissions for this search.

per_page

number

The number of results per page.

page

number

The current page of results.

total_pages

number

The number of pages total for this query.

more_results

boolean

Whether there are more results or not.

Response Object

{
  "submissions": [
    {
      "id": "987654321",
      "created_at": "2021-02-04T22:52:32.098Z",
      "is_spam": false,
      "is_read": true,
      "form_id": "123456789",
      "body": {
        "email": "hello@example.com",
        "message": "Hi there! Just testing this form.",
        "form_name": "Contact Form",
        "referer": "https://example.com/contact"
      }
    },
  ],
  "total_submissions": 1,
  "per_page": 100,
  "page": 1,
  "total_pages": 1,
  "more_results": false
}

Endpoints

POST / Submit A Form
GET / All Submissions
GET / Submissions By Form
GET / Submission By ID

API DOCS

Submission By ID

GET/v1/submissions/{SUBMISSION_ID}

Using this submission API endpoint, you can return a list of submissions using various filters that are similar to the functionality available in your Formeezy submissions dashboard.

Parameters

Request

https://formeezy.com/api/v1/submissions/{SUBMISSION_ID}

Get your free API key →

Request Headers

X-API-Key

required

Your unique key for making requests.

{'X-API-KEY': '{YOUR_API_KEY}'}

Response Attributes

id

string

The ID of the submission.

created_at

date

The date this submission was created.

is_spam

boolean

The current spam status of this submission.

is_read

boolean

The current read/unread status.

form_id

string

The ID of the form this submission was sent to.

body

object

The body of your form submission.

Response Object

{
  "id": "987654321",
  "created_at": "2021-02-04T22:52:32.098Z",
  "is_spam": false,
  "is_read": true,
  "form_id": "123456789",
  "body": {
    "email": "hello@example.com",
    "message": "Hi there! Just testing this form.",
    "form_name": "Contact Form",
    "referer": "https://example.com/contact"
  }
}

Was this helpful?

Formeezy Submissions API

Getting Started

Making Authorized API Requests

Formeezy API Overview

Submission Form Examples

Generating Your API Key

Endpoints

Submit A Form

Parameters

Request

Request Body

Request Headers

X-API-Key

X-URL

Response Attributes

redirect

Error Response Object

Error Response Attributes

status

message

redirect

Response Object

Endpoints

All Submissions

Parameters

Request

Request Headers

X-API-Key

Response Attributes

submissions

id

created_at

is_spam

is_read

form_id

body

total_submissions

per_page

page

total_pages

more_results

Response Object

Endpoints

Submissions By Form

Parameters

Request

Request Headers

X-API-Key

Response Attributes

submissions

id

created_at

is_spam

is_read

form_id

body

total_submissions

per_page

page

total_pages

more_results

Response Object

Endpoints

Submission By ID

Parameters

Request

Request Headers

X-API-Key

Response Attributes

id

created_at

is_spam

is_read

form_id

body

Response Object