List forms

List all forms.

GET /forms

List all forms

cURL

curl --request GET \
  --url https://{your-subdomain}.neetoform.com/api/external/v2/forms \
  --header 'X-Api-Key: <x-api-key>'

200

{
  "forms": [
    {
      "id": "<string>",
      "title": "<string>",
      "is_published": true,
      "state": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "submissions_count": 123,
      "attempt_url": "<string>",
      "is_archived": true,
      "is_disabled": true,
      "is_suspended": true,
      "created_by": "<string>"
    }
  ],
  "pagination": {
    "total_records": 123,
    "total_pages": 123,
    "current_page_number": 123,
    "page_size": 123
  },
  "total_count": 123
}

Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key · string · default: your-api-key · required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Query Parameters

page_number · integer

Retrieve paginated results by specifying the desired page number. If this parameter is absent, all results will be returned.

page_size · integer

Set the number of results returned in the response. Defaulting to 30 when omitted.

Response

200 - application/json

OK - Request succeeded

forms · object[]

Hide child attributes

forms. id · string

forms. title · string

forms. is_published · boolean

forms. state · string

forms. created_at · string<date-time>

forms. updated_at · string<date-time>

forms. submissions_count · integer

forms. attempt_url · string

forms. is_archived · boolean

forms. is_disabled · boolean

forms. is_suspended · boolean

forms. created_by · string

pagination · object

Hide child attributes

pagination. total_records · integer

pagination. total_pages · integer

pagination. current_page_number · integer

pagination. page_size · integer

total_count · integer