List all submissions

Overview

The list all submissions API allows users to retrieve all submissions of a specified form in a workspace, supporting both paginated and non-paginated responses.

Base URL

https://<workspace>.neetoform.com/api/external/v1

Replace the <workspace> with your workspace subdomain.

Endpoint

GET /forms/<form_id>/submissions

Replace the <form_id> with the ID of the form for which you want to fetch submissions.

Request header

This endpoint requires authentication. You must include a valid API key in the request header.

Header	Type	Required	Description
X-Api-Key	String	Yes	Token for API access

Query parameters

Parameter	Type	Required	Description
page	Number	No	Use this parameter to retrieve paginated submissions by specifying the desired page number. If this parameter is absent, all submissions will be returned.
page_size	Number	No	Use this parameter to set the number of results returned in the response, defaulting to 30 when omitted.

Example

1. To retrive all submissions of a form with ID 238c77e9-f9b5-4cf7-b15a-a16b703ff4d6 in a workspace "Spinkart" with subdomain spinkart using curl:

Request

curl --location 'https://spinkart.neetoform.com/api/external/v1/forms/238c77e9-f9b5-4cf7-b15a-a16b703ff4d6/submissions' \
  --header 'X-Api-Key: YOUR_API_KEY'

Response

{
  "submissions": [
    {
      "id": "1924e043-9e83-414e-a8e2-da4de445044e",
      "created_at": "2024-01-01T08:01:56.864Z",
      "field_values": [
        {
          "id": "sd386c47-8c46-4735-9898-aaa240aa854r",
          "data": { "value": "aw3980db-1151-4ca9-93ab-64908a645d57" },
          "field_id": "23w42c08-8281-410c-b5cb-93bcf67c6bd9",
          "resource_type": "Submission",
          "resource_id": "1924e043-9e83-414e-a8e2-da4de445044e",
          "created_at": "2024-01-24T09:29:00.363Z",
          "updated_at": "2024-01-24T09:29:00.363Z"
        },
        ...
      ],
      "user_agent": {
        "id": "2aq839c9-c4f0-4cf2-93ce-b348de80fdf5",
        "name": "Chrome",
        "version": "120.0.0.0",
        "ip_address": "120.63.110.198",
        "device_name": null,
        "device_type": "desktop",
        "operating_system": "Mac",
        "operating_system_version": "10.15.7",
        "submission_id": "1924e043-9e83-414e-a8e2-da4de445044e",
        "created_at": "2024-01-01T08:03:56.870Z",
        "updated_at": "2024-01-01T08:03:56.870Z"
      },
      "responses": [
        {
          "id": "bc4ba778-feb5-48bd-b5d9-c2669fc0csw4",
          "label": "Email",
          "position": 1,
          "kind": "email_address",
          "slug": "email-address",
          "value": "[email protected]"
        },
        ...
      ]
    },
    ...
  ],
  "total_count": 16
}

2. To retrieve submissions of a form with ID 238c77e9-f9b5-4cf7-b15a-a16b703ff4d6 from the second page of the "Spinkart" workspace with the subdomain spinkart, where each page contains 15 results using curl:

Request

curl --location 'https://spinkart.neetoform.com/api/external/v1/forms/238c77e9-f9b5-4cf7-b15a-a16b703ff4d6/submissions?page=2&page_size=15' \
  --header 'X-Api-Key: YOUR_API_KEY'

Response

{
  "submissions": [
    {
      "id": "9eee27e6-0594-4ec2-9d6a-8788a3d867a7",
      "created_at": "2024-01-01T08:01:56.864Z",
      "field_values": [
        {
          "id": "8308ca62-1b87-41f7-aebe-838729bb1294",
          "data": { "value": "b61390c2-de1e-4b5a-8027-856140581556" },
          "field_id": "4662ec45-ec32-4052-b97c-d858c0a52e94",
          "resource_type": "Submission",
          "resource_id": "9eee27e6-0594-4ec2-9d6a-8788a3d867a7",
          "created_at": "2024-01-24T09:29:00.363Z",
          "updated_at": "2024-01-24T09:29:00.363Z"
        },
        ...
      ],
      "user_agent": {
        "id": "32f6d8d5-f652-44a1-8cb2-1add33abdcd0",
        "name": "Chrome",
        "version": "120.0.0.0",
        "ip_address": "120.63.111.198",
        "device_name": null,
        "device_type": "desktop",
        "operating_system": "Mac",
        "operating_system_version": "10.12.7",
        "submission_id": "9eee27e6-0594-4ec2-9d6a-8788a3d867a7",
        "created_at": "2024-01-01T08:05:56.870Z",
        "updated_at": "2024-01-01T08:05:56.870Z"
      },
      "responses": [
        {
          "id": "5c834f3a-ce45-42ec-b76c-1e755595d5d5",
          "label": "Email",
          "position": 1,
          "kind": "email_address",
          "slug": "email-address",
          "value": "[email protected]"
        },
        ...
      ]
    }
  ],
  "total_count": 16
}

Response Codes

Code	Description
200	OK - Request succeeded
401	Unauthorized - Missing/invalid API key
404	Not found - Invalid form ID
500	Internal server error