Skip to navigation

List

List the launches in your organization, or with mine=true your own, the ones the app’s My launches page counts as yours. Drafts included, by planned launch date. Every period unless period (or year) narrows it, where the app’s lists open on this quarter and later: period=upcoming lists what they do. With launched=true it is the Launched page instead: launches that have launched, newest first, with the periods going by when each launched. Needs launches:read.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

statusenumOptional
Where a launch sits in its lifecycle.
ownerUserIdstringOptional
Launches this person owns.
pmUserIdstringOptional

The older name for ownerUserId.

orgTeamIdstringOptional
Launches that belong to this team.
qstringOptional

Search launches by their name, description, key customers and owners’ names. Every word must appear in one of those fields; case and accents are ignored; at most 100 characters and 8 words. See Searching under Errors and pagination.

searchstringOptionalDeprecated

The older name for q, matched the same way. Deprecated; q wins when both are sent.

launchTemplateIdstringOptional
Launches that use this launch template.
draftbooleanOptional

true lists only drafts and false only what is published; left out, both.

healthstringOptional

ON_TRACK, AT_RISK or OFF_TRACK, as the newest update says (never a launched launch), or NONE for launches with no health to show.

periodstringOptional

A fiscal period, as the app’s period picker and its URL name them: a quarter (2026-Q4), a whole year (2027), upcoming for this quarter and every one after it, or all. Repeat it for several (period=2026-Q4&period=2027-Q1); upcoming or all among them wins over the rest. Narrows by planned launch date in the workspace’s fiscal years, upcoming keeping launches with no date yet, as the app’s lists do; with launched=true, by when each launched. Left out, with no year, every period. Wins over year and quarter; anything else is a 422 validation_error.

yearintegerOptional

One fiscal year, as the workspace’s fiscal year start names it. Narrows by planned launch date (actual with launched=true); left out, every year. period takes several.

quarterintegerOptional

A fiscal quarter, 1 to 4, of year. Needs year; left out, the whole year.

minebooleanOptional

true lists only your own launches, as My launches does: those you own or follow as a stakeholder and, unless includeTeams=false, every launch of an organizational team you are on (or of a team inside one). It narrows alongside the other filters. A signed-in session’s are its person’s; an API key’s are its maker’s, the person who created it, and a key whose maker has left the workspace has none and is refused with 403 forbidden. For somebody else’s, use ownerUserId.

includeTeamsbooleanOptional

With mine=true, false leaves out launches that are yours only through a team. Left out, true.

launchedbooleanOptional

true lists what the Launched page does: only launches that have launched (status LAUNCHED), newest first by actualLaunchDate, with period, year and quarter going by when each launched rather than when it was planned. That is how the Overview counts launchedThisQuarter: a launch planned for last quarter that went out in this one is this quarter’s. launched=true&period=2026-Q4 is what shipped in that quarter. Left out, by planned launch date.

limitintegerOptional
cursorstringOptional

Response

This endpoint returns an object.
datalist of objects
hasMoreboolean
nextCursorstringOptional

Errors

401
Unauthorized Error
402
Subscription Required Error
403
Forbidden Error
422
Validation Error
429
Too Many Requests Error