GET
/
forms
List all forms
curl --request GET \
  --url https://{your-workspace}.neetoform.com/api/external/v1/forms \
  --header 'X-Api-Key: <x-api-key>'
{
  "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>"
    }
  ],
  "total_count": 123
}
Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

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

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Query Parameters

​
page_number
integer

Retrieve paginated forms by specifying the desired page number. If this parameter is absent, all forms 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

The response is of type object.