# Forms API

The Forms API allows you to retrieve forms from your tenant.

Required Scope: read:forms

# Endpoints

Method	Endpoint	Description
GET	`/forms`	List all forms

# List Forms

Retrieve a list of forms from your tenant.

GET /forms

# Query Parameters

Parameter	Type	Required	Default	Description
`client_id`	string	Yes	-	Your developer client ID
`client_secret`	string	Yes	-	Your developer client secret
`grant_type`	string	Yes	-	Must be `client_credentials`
`limit`	number	No	5	Maximum number of forms to return

# Request Examples

# Get Default Forms (5 items)

curl -X GET 'https://api.admin.novti.io/forms?client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&grant_type=client_credentials'

# Get N Forms (e.g., 10)

curl -X GET 'https://api.admin.novti.io/forms?limit=10&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&grant_type=client_credentials'

# Response

Success (200 OK)

{
  "status": "Success",
  "data": [
    {
      "id": "form123",
      "name": "Contact Form",
      "fields": [
        {
          "name": "email",
          "type": "email",
          "required": true
        },
        {
          "name": "message",
          "type": "textarea",
          "required": true
        }
      ],
      "settings": { },
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-03-20T14:22:00Z"
    },
    {
      "id": "form456",
      "name": "Newsletter Signup",
      "fields": [
        {
          "name": "email",
          "type": "email",
          "required": true
        }
      ],
      "settings": { },
      "createdAt": "2024-02-01T08:00:00Z",
      "updatedAt": "2024-02-15T12:30:00Z"
    }
  ],
  "meta": {
    "size": 2
  }
}

# Form Object

Field	Type	Description
`id`	string	Unique identifier for the form
`name`	string	Display name of the form
`fields`	array	List of form fields with their configurations
`settings`	object	Form-specific settings
`createdAt`	string (ISO 8601)	Creation timestamp
`updatedAt`	string (ISO 8601)	Last update timestamp

# Field Object

Field	Type	Description
`name`	string	Field identifier
`type`	string	Field type (e.g., `email`, `text`, `textarea`, `select`)
`required`	boolean	Whether the field is mandatory
`label`	string	Display label for the field
`placeholder`	string	Placeholder text
`options`	array	Options for select/radio fields

# See Also

← Pages API Organization API →