Skip to main content

​
Step 1: Make Your First API Call

Let’s retrieve all forms in your workspace using a GET request: 
curl -X GET "https://{your-subdomain}.neetoform.com/api/external/v1/forms" \
  -H 'X-Api-Key: your-api-key' \
  -H 'Content-Type: application/json'
Replace your-subdomain with your actual workspace subdomain and your-api-key with your generated API key.

​
Step 2: Understanding the Response

A successful response will look like this: 
{
  "forms": [
    {
      "id": "form-123",
      "title": "Contact Form",
      "is_published": true,
      "state": "active",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "submissions_count": 42,
      "attempt_url": "https://mycompany.neetoform.com/forms/form-123",
      "is_archived": false,
      "is_disabled": false,
      "is_suspended": false,
      "created_by": "user@example.com"
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page_number": 1,
    "page_size": 30
  },
  "total_count": 1
}

​
Next Steps

Now that you’ve made your first API call, you can:

Explore API Reference

Browse all available endpoints and their detailed documentation.

Pagination

Understand how to paginate through API responses efficiently.

HTTP response codes

Learn what different response codes mean and how to handle them.