GuidesAPI DocsChangelogMy AppsSeismic Exchange
API Docs

Get programs

get
https://api.seismic.com/programs/v2/spaces//programs

Get a list of programs with their attributes and associations.

Options for filtering by programs include:

  • start/end dates
  • program IDs
  • title
  • creator user IDs
  • manager user IDs
  • custom properties
  • associated content, task, or request IDs
  • current phase IDs
  • include deactivated programs
Path Params
string
required

Space ID

Query Params
date-time

Filter from a planned end date (complete phase date)

date-time

Filter to a planned end date (complete phase date)

date-time

Filter from a planned start date (planning phase date)

date-time

Filter to a planned start date (planning phase date)

date-time

Filter from a launch date (active phase date)

date-time

Filter to a launch date (active phase date)

ids
array of strings

List of program IDs to query by

ids
string

Program title to query by

managerIds
array of strings

List of user IDs to query by manager

managerIds
creatorIds
array of strings

List of user IDs to query by creator

creatorIds
associatedNodeIds
array of strings

List of association IDs to query by

associatedNodeIds
string

Cursor used for pagination

int32

Number to limit records returned

sort
array of strings

Sort query

sort
customProperties
object

List of custom properties to query by

followerIds
array of strings

List of user IDs to query by follower

followerIds
boolean

Query only activated or deactivated programs

audience
array of strings

List of program audience user IDs to query by

audience
topics
array of strings

List of program topics to query by

topics
string
enum

ProgramType enum to query by

Allowed:
string
enum

First OutcomeKpi/Metric enum to query by

Allowed:
string
enum

Second OutcomeKpi/Metric enum to query by

Allowed:
string
enum

Third OutcomeKpi/Metric enum to query by

Allowed:
currentPhases
array of strings

A list of current phase IDs to query by

currentPhases
boolean
Defaults to false

Indicator to allow for inclusion of association data

boolean
Defaults to false

Indicator to allow for inclusion of deactivated programs (ignored when enabled
is passed)

boolean
Defaults to false

Attached page data and the content data inside those pages can be included using the includePages parameter

Responses

Updated 5 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago