List Forms

Retrieve a paginated list of all root forms in your workspace.

Use Cases:

• Display all forms in your application dashboard
• Build form selection dropdowns
• Export form metadata
• Monitor form deployment status
• Sync forms with external systems

Behavior:

• Returns only root forms (parentId is null)
• Does not include form versions - use GET /v1/forms/{formId}/versions for versions
• Results are paginated using cursor-based pagination
• Forms are sorted by ID in descending order (newest first)
• Returns forms in all statuses (DRAFT, PUBLISHED, ARCHIVED)
• Form must belong to your workspace

Cursor-Based Pagination:

• Use limit to specify page size (default: 20, max: 100)
• Use after cursor to fetch next page
• Use before cursor to fetch previous page
• hasMore indicates if more results are available

Required Scope: read:forms

Response Fields:

• id: Unique form identifier
• name: Form name
• description: Form description (optional)
• status: DRAFT, PUBLISHED, or ARCHIVED

Pagination Example:

1. First request: GET /v1/forms?limit=20
2. Get last item ID from response
3. Next page: GET /v1/forms?limit=20&after=
4. Check hasMore to see if more pages exist