Query program templates

Retrieves a filtered and paginated list of program templates based on specified criteria. Supports extensive
filtering by dates, creators, associations, custom properties, and more. Use for displaying template catalogs,
searching templates, or building template selection interfaces.

Key Features:

  • Query templates using flexible filtering options including planned dates, launch dates, creators, followers, title search, custom properties, content associations, audience targeting, and recurrence settings
  • Perform flexible sorting on multiple fields to organize templates by various criteria
  • Navigate template catalogs efficiently with cursor-based pagination for responsive user interfaces
  • Optionally include associations and page configurations for complete template structure and content details
  • Results are automatically filtered based on user's access permissions ensuring proper security

Authorization Logic:

  1. User must have a valid token with viewing or management scopes
  2. User must have program update permissions
  3. User can only view templates they have permission to access
  4. Results are filtered based on user's access rights

Usage Example:

Query templates to display available options when creating a new program, search for templates
by title or creator, or find templates with specific recurrence settings for automated program generation.

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
date-time

Optional filter for templates with planned end date on or after this date (inclusive). Useful for finding
templates with upcoming or future deadlines.

date-time

Optional filter for templates with planned end date before this date (exclusive). Combine with plannedEndDateFrom
to define a specific date range for template deadlines.

date-time

Optional filter for templates with planned start date on or after this date (inclusive). Use with plannedStartDateTo to define a start date range.

date-time

Optional filter for templates with planned start date before this date (exclusive). Use with plannedStartDateFrom
to define a start date range.

date-time

Optional filter for templates with launch date on or after this date (inclusive). Useful for tracking template launches.

date-time

Optional filter for templates with launch date before this date (exclusive). Use with launchDateFrom to define launch date range.

ids
array of strings

Optional array of specific template IDs to retrieve. When provided, only these templates are returned.

ids
string

Optional template title to search for. Performs partial matching on template titles.

creatorIds
array of strings

Optional array of user IDs to filter by template creator. Returns templates created by any of the specified users.

creatorIds
associatedNodeIds
array of strings

Optional array of node IDs to filter by associations. Returns templates associated with any of the specified entities.

associatedNodeIds
string

Optional pagination cursor from a previous response. Use to retrieve the next page of results.

int32

Optional maximum number of templates to return per page. Valid range typically 1-100. Default is 50.

sort
array of strings

Optional array of sort criteria in format 'field:direction'. Supported fields: createdAt, updatedAt, plannedStartDate, plannedEndDate, launchDate, title.
Supported directions: asc, desc.

sort
boolean

Optional flag to include detailed association data in the response. Default is false.

customProperties
object

Optional custom property filters. Filter by property ID with criteria including operator and value.

Filter Syntax:

  • customProperties[{propertyId}][operator]={operator} - Use operators like Equal, ArrayContains, Contains, etc.
  • customProperties[{propertyId}][id]=%22{valueId}%22 - Filter by value ID (URL-encoded with %22)
  • customProperties[{propertyId}][value]=%22{value}%22 - Filter by value directly (URL-encoded with %22)

Example: customProperties[abc123][operator]=Equal&customProperties[abc123][id]=%22xyz789%22

followerIds
array of strings

Optional array of user IDs to filter by followers. Returns templates followed by any of the specified users.

followerIds
boolean
Defaults to false

Optional flag to include page configurations and content data. Default is false.

Responses

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