API ReferenceForms
List forms with search, filtering, sorting, and pagination
Authorization
api-key X-API-Key<token>
In: header
Query Parameters
page?number
Range
1 <= valueDefault
1limit?number
Max 100
Range
1 <= value <= 100Default
20search?string
Case-insensitive search on form name
status?string
Value in
- "draft"
- "published"
- "archived"
type?string
Value in
- "inline"
- "popup"
- "landing_page"
- "sticky_bar"
- "slide_in"
sortBy?string
Default
"createdAt"Value in
- "createdAt"
- "name"
- "publishedAt"
- "submissionsCount"
order?string
Default
"desc"Value in
- "asc"
- "desc"
from?string
Filter forms created on or after this date
to?string
Filter forms created on or before this date
Response Body
application/json
curl -X GET "https://example.com/api/v1/forms"{ "data": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "workspaceId": "550e8400-e29b-41d4-a716-446655440000", "name": "Newsletter Signup", "type": "inline", "status": "draft", "segmentId": null, "fields": [], "styles": {}, "successMessage": "Thanks for subscribing!", "redirectUrl": null, "doubleOptIn": false, "consentStatement": null, "privacyPolicyUrl": null, "captureTimezone": false, "landingPageMeta": null, "viewsCount": 0, "submissionsCount": 0, "createdAt": "2026-01-01T00:00:00.000Z", "updatedAt": "2026-01-01T00:00:00.000Z", "publishedAt": null, "deletedAt": null } ], "total": 1, "page": 1, "limit": 50}