Skip to main content
GET
/
forms
List all forms
curl --request GET \
  --url https://{your-subdomain}.neetoform.com/api/external/v1/forms \
  --header 'X-Api-Key: <x-api-key>'
import requests

url = "https://{your-subdomain}.neetoform.com/api/external/v1/forms"

headers = {"X-Api-Key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>'}};

fetch('https://{your-subdomain}.neetoform.com/api/external/v1/forms', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{your-subdomain}.neetoform.com/api/external/v1/forms",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{your-subdomain}.neetoform.com/api/external/v1/forms"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://{your-subdomain}.neetoform.com/api/external/v1/forms")
  .header("X-Api-Key", "<x-api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{your-subdomain}.neetoform.com/api/external/v1/forms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body
{
  "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
}
This endpoint is part of API v1, which is deprecated. Please use the v2 API instead.
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[]
​
pagination
object
​
total_count
integer