← Back to API
List forms
List forms owned by the API key's account.
GET /api/v1/forms
Request
Query parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
limit | integer | 20 | Number of forms to return. Max 100. |
Response (success)
Status: 200 OK
{
"success": true,
"data": {
"forms": [
{
"id": "form_1739012345_abc123xyz",
"title": "Contact Form",
"formUrl": "https://www.chatterforms.com/forms/form_1739012345_abc123xyz",
"createdAt": "2025-01-08T12:00:00.000Z",
"isPublished": true
}
],
"total": 42
},
"meta": { "request_id": null, "api_version": "2024-01-01" }
}Code examples
curl -X GET "https://backend.chatterforms.com/api/v1/forms?limit=10" \
-H "Authorization: Bearer cf_live_YOUR_API_KEY"const API_KEY = 'cf_live_YOUR_API_KEY';
const BASE_URL = 'https://backend.chatterforms.com';
async function listForms(limit = 20) {
const res = await fetch(
`${BASE_URL}/api/v1/forms?limit=${limit}`,
{ headers: { Authorization: `Bearer ${API_KEY}` } }
);
const json = await res.json();
if (!json.success) throw new Error(json.error?.message || 'Request failed');
return json.data;
}
// Usage
const { forms, total } = await listForms(10);
console.log(`Found ${total} forms:`, forms);import requests
API_KEY = 'cf_live_YOUR_API_KEY'
BASE_URL = 'https://backend.chatterforms.com'
def list_forms(limit: int = 20) -> dict:
url = f'{BASE_URL}/api/v1/forms'
headers = {'Authorization': f'Bearer {API_KEY}'}
params = {'limit': limit}
response = requests.get(url, headers=headers, params=params)
data = response.json()
if not data.get('success'):
raise Exception(data.get('error', {}).get('message', 'Request failed'))
return data['data']
# Usage
data = list_forms(10)
print(f"Found {data['total']} forms:", data['forms'])Error responses
| Status | Code | Description |
|---|---|---|
| 401 | INVALID_API_KEY | Missing or invalid API key |
| 500 | INTERNAL_ERROR | Internal error |
See Errors for details.