Get request forms

Retrieves a filtered and paginated list of request forms configured within the specified space. Request forms are structured templates that define how users submit requests for content, programs, tasks, or other initiatives, enabling standardized intake processes and self-service workflows. This endpoint supports filtering by form name, activation status, and cursor-based pagination for efficiently navigating large form libraries.

Key Features:

  • Query forms using flexible filtering: search by name substring (case-insensitive), filter by activation status (activated=true/false)
  • Control payload size and response detail with includeCustomProperties flag to include or exclude custom field definitions
  • Navigate large form collections efficiently with cursor-based pagination using limit and cursor parameters
  • Results automatically filtered based on user's space access permissions ensuring proper security boundaries
  • Returns comprehensive form metadata including formId, name, activation status, creation/update timestamps, and optional custom properties

Common Use Cases:

  • Display available request forms in user-facing form selection interfaces for content requests, program proposals, or task submissions
  • Administrative form management: retrieve all forms (activated and deactivated) for configuration, auditing, or lifecycle management
  • Search for specific forms: use name parameter to find forms like 'Content Request' or 'Marketing Campaign Proposal' by partial name matching
  • Discover active forms only: filter with activated=true to show forms currently available for end-user request submission
  • Form library management: retrieve all forms with includeCustomProperties=true to analyze field structures, validation rules, and metadata schemas across the organization

Practical Examples:

  • Retrieve active forms for dropdown: GET /v2/spaces/w5PmrE9p0kicqqRSVJ3VBQ/forms?activated=true&limit=50 returns first 50 active forms users can submit requests with
  • Search for content-related forms: GET /v2/spaces/w5PmrE9p0kicqqRSVJ3VBQ/forms?name=Content&limit=20 finds all forms with 'Content' in the name (e.g., 'Content Request Form', 'Content Approval Form')
  • Admin view of all forms: GET /v2/spaces/w5PmrE9p0kicqqRSVJ3VBQ/forms?includeCustomProperties=true&limit=100 retrieves comprehensive form data including custom property definitions for management dashboards
  • Paginate through large form libraries: First request returns cursor='abc123xyz', next request uses ?cursor=abc123xyz&limit=50 to fetch subsequent pages

Response Interpretation:

  • RequestFormQueryResponse contains 'count' (forms in current page), 'cursor' (pagination token for next page, null when no more results), 'items' (array of RequestForm objects), and optional metadata
  • Check cursor in response: if null, you've retrieved all matching forms; if non-null, pass it to next request to continue pagination
  • Each form in 'items' includes formId (unique identifier), name (display name), activated (availability status), createdAt/updatedAt timestamps, and optionally custom property definitions if includeCustomProperties=true was specified

Authorization Logic:

  1. User must have valid JWT token with seismic.programs.view or seismic.programs.manage scope
  2. Results automatically filtered to forms user has permission to view based on space roles and form visibility settings
  3. Forms marked as private or restricted may be filtered from results based on user's permission level
Path Params
string
required
length between 7 and 22

The unique identifier of the space containing the target entity. This determines the scope of entity queries and ensures proper access control. The space must be accessible to the authenticated user with appropriate permissions. It can be the unique identifier (GUID) of the space or the word "default" to indicate the default programs space. Common values include "default" and "rkr83lapKkyCJuLLWqLqzB".

Query Params
string

Optional filter to search for request forms by their display name using case-insensitive substring matching. When provided, only forms whose names contain this text are returned, enabling users to quickly find forms by partial name. For example, searching for 'Content' matches forms named 'Content Request Form', 'Marketing Content Submission', or 'Sales Content Intake'. Omit to retrieve all forms without name filtering. Useful for form discovery, search interfaces, and finding specific form templates by recognizable names.

boolean

Optional boolean filter to retrieve only activated (true) or deactivated (false) request forms based on their availability status. When true, returns only forms that are active and available for users to submit requests. When false, returns only deactivated forms that are temporarily unavailable or under configuration. Omit this parameter to retrieve all forms regardless of activation status. Use to filter form lists for user-facing form selection interfaces (activated=true) or administrative management views showing disabled forms (activated=false). Essential for controlling which forms appear in request submission workflows.

boolean
Defaults to false

Optional boolean flag controlling whether custom property definitions and configurations are included in the response for each returned form. When true, the response includes complete custom property metadata such as field types, validation rules, possible values, and display configurations for all custom properties associated with each form. When false (default), custom properties are excluded to reduce payload size and improve response times for scenarios where only basic form metadata is needed. Set to true when building form editors, configuration interfaces, or detailed form management views that require full custom property information. Defaults to false for optimal performance in list views.

string

Opaque pagination cursor string returned by the API in the previous response's cursor field. Pass this exact value as-is (without parsing or modification) in subsequent requests to fetch the next page of results. The cursor encodes the current position in the result set and maintains consistency even when underlying data changes between requests. When null or omitted, the query returns the first page. When the API returns a null cursor in the response, it indicates you've reached the last page with no more results available. Cursor-based pagination is preferred over offset-based pagination for large, frequently changing datasets because it prevents skipped or duplicate items across page boundaries.

int32
Defaults to 50

Optional maximum number of request forms to return in a single page of results, controlling the page size for pagination. Must be a positive integer. Defaults to 50 if not specified, which provides a good balance between response payload size and number of requests needed to retrieve large result sets. Typical values range from 10 (for quick initial loads with minimal latency) to 100 (for bulk data retrieval with fewer API calls). The actual count of forms returned may be less than this limit on the final page or when fewer forms match the query criteria. Use smaller limits for faster initial responses in user interfaces and larger limits for batch processing or bulk data exports.

Responses

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json