List all forms

Overview

The list all forms API allows users to retrieve all forms 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

Request header

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

Query parameters

Example

1. To retrieve all forms of a workspace "Spinkart" with subdomain spinkart using curl:

Request

curl --location 'https://spinkart.neetoform.com/api/external/v1/forms' \
  --header 'X-Api-Key: YOUR_API_KEY'

Response

{
  "forms": [
      {
          "id": "27sc77e9-f9b5-4cf7-b15a-a16b703ff22z",
          "title": "Event registration form",
          "is_published": true,
          "state": "published",
          "created_at": "2024-07-17T11:01:27.261Z",
          "updated_at": "2024-07-17T11:06:31.107Z",
          "submissions_count": 470,
          "attempt_url": "https://spinkart.neetoform.com/2f215dc5385818409abc",
          "is_archived": true,
          "is_disabled": false,
          "is_suspended": false,
          "created_by": "Oliver Smith"
      },
      ...
  ],
  "total_count": 61
}

2. To retrieve forms from the third page of the "Spinkart" workspace with the subdomain spinkart, where each page contains 30 results using curl:

Request

curl --location 'https://spinkart.neetoform.com/api/external/v1/forms?page_number=3&page_size=30' \
  --header 'X-Api-Key: YOUR_API_KEY'

Response

{
  "forms": [
      {
          "id": "808c77e9-f9b5-4cf7-b15a-a16b703ff43e",
          "title": "Event feedback form",
          "is_published": true,
          "state": "published",
          "created_at": "2024-09-12T11:02:49.248Z",
          "updated_at": "2024-09-12T11:03:11.319Z",
          "submissions_count": 236,
          "attempt_url": "https://spinkart.neetoform.com/a6215dc5385818409xyz",
          "is_archived": false,
          "is_disabled": false,
          "is_suspended": false,
          "created_by": "Adam Smith"
      }
  ],
  "total_count": 61
}

Response Codes