Get all programs

get

https://api.seismic.com/programs/v2/spaces/{spaceId}/programs

Retrieves a list of programs within a space with extensive filtering capabilities including date ranges, managers,
custom properties, associations, program types, and Slack integrations. This endpoint supports cursor-based
pagination and flexible sorting for building program management interfaces and reporting systems.

Key Features:

Query programs using multiple filtering criteria simultaneously including date ranges, managers, creators,
followers, custom properties, associations, program types, onboarding groups, outcome metrics, and Slack integrations
Perform flexible sorting on multiple fields for optimal display ordering and data organization
Navigate large datasets efficiently with cursor-based pagination for responsive user interfaces
Optionally include associations and page data for detailed program views with complete context
Results include complete program metadata such as managers, phases, analytics settings, and associations

Authorization Logic:

User must have a valid JWT token with viewing or management scopes
Programs are filtered based on user's access permissions

Usage Example:

Retrieve all programs managed by specific users within a date range for dashboard display and workload management,
or filter by program type and outcome metrics for strategic planning.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

spaceId

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

plannedEndDateFrom

date-time

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

plannedEndDateTo

date-time

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

plannedStartDateFrom

date-time

Optional filter for programs with planned start date on or after this date (inclusive). Helps identify programs
scheduled to begin within a specific timeframe.

plannedStartDateTo

date-time

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

launchDateFrom

date-time

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

launchDateTo

date-time

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

ids

array of strings

Optional array of program IDs to retrieve specific programs. When provided, only programs matching these IDs will be returned.

ids

title

string

Optional keyword to search within program titles. Enables partial text matching for finding programs by name.

managerIds

array of strings

Optional array of user IDs to filter programs by manager (the user managing the program).

managerIds

creatorIds

array of strings

Optional array of user IDs to filter programs by creator (the user who created the program).

creatorIds

associatedNodeIds

array of strings

Optional array of associated node IDs to filter programs by their associations (tasks, content, or requests).

associatedNodeIds

cursor

string

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

limit

int32

Optional limit for number of programs to return per page. Defaults to 50 if not specified.

sort

array of strings

Optional array of sort criteria in format 'field:direction'.

Supported fields: createdAt, updatedAt, plannedStartDate, plannedEndDate, launchDate.

Supported directions: asc, desc.

sort

customProperties

object

Optional dictionary of custom property filters. Filter by custom property ID and value using query objects.

Filter Syntax:

customProperties[{propertyId}][operator]={operator} - Comparison operator (Equal, Contains, ArrayContains, etc.)
customProperties[{propertyId}][id]=%22{valueId}%22 - Filter by specific custom property value ID
customProperties[{propertyId}][value]=%22{value}%22 - Filter by custom property value directly

URL Encoding: Both id and value parameters must be enclosed in quotes and URL-encoded (%22 for quotes).

Example: Filter tasks where custom property "FTFcbnlcfkKZCmnew-bGxw" equals value "DJF4u1C75kiTpwFV350Frg":

customProperties[FTFcbnlcfkKZCmnew-bGxw][operator]=Equal&customProperties[FTFcbnlcfkKZCmnew-bGxw][id]=%22DJF4u1C75kiTpwFV350Frg%22

followerIds

array of strings

Optional array of user IDs to filter programs by followers.

followerIds

archived

boolean

Optional filter to show only archived (true) or active (false) programs. Omit to show all.

audience

array of strings

Optional array of audience identifiers to filter programs by target audience. Uses OR logic: programs matching ANY of the specified audiences will be returned. This differs from other array filters like followerIds which use AND logic.

audience

topics

array of strings

Optional array of topic identifiers to filter programs by topic categories.

topics

programType

string

enum

[DEPRECATED] Optional program type enum to filter by. Available values: Campaign, ContentCreation, ProductLaunch,
Training, Other.

This parameter is deprecated and will be removed in a future version. Use programTypes filter instead for better
flexibility.

Allowed:

outcomeKpiFirst

string

enum

Optional first outcome KPI/metric enum to filter programs by primary success metric.

Allowed:

outcomeKpiSecond

string

enum

Optional second outcome KPI/metric enum to filter programs by secondary success metric.

Allowed:

outcomeKpiThird

string

enum

Optional third outcome KPI/metric enum to filter programs by tertiary success metric.

Allowed:

currentPhases

array of strings

Optional array of current phase IDs to filter programs by their current workflow phase.

currentPhases

includeAssociations

boolean

Defaults to false

Optional indicator to include association data (tasks, content, requests) in the response. Defaults to false.

includeDeactivatedPrograms

boolean

Defaults to false

Optional indicator to include deactivated/archived programs in results (ignored when archived parameter is passed). Defaults to false.

includePages

boolean

Defaults to false

Optional indicator to include page model data in the response. Defaults to false.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully retrieved programs matching the specified filters. Returns a paginated list with metadata.

400Invalid request parameters. Common causes include malformed date formats, invalid program IDs, malformed cursor, invalid sort parameters, or excessive limit values.

401Authentication failed due to missing, invalid, or expired JWT token. Obtain a valid token with required permission scopes.

403Access denied due to insufficient permissions to access entity or perform the requested action. Contact your administrator for assistance.

404Entity not found. Verify the entity ID exists to ensure proper permissions are granted.

500Internal server error during entity retrieval, mutation, or deletion.