Skip to main content
GET
List roadmaps
Returns roadmaps: by owner (ownerKind, optionally ownerRefId) in owner order, by status (DRAFT, ACTIVE, ARCHIVED) newest first, or unfiltered newest first. ownerRefId requires ownerKind. limit defaults to 50, at most 100 (a larger value is 400 too_big). Pass meta.nextCursor unchanged while meta.hasMore is true; a short page does not mean the list is done. A cursor reused with different filters, or an unknown or repeated parameter, is 400 bad_request. The credential needs the objectives:read scope and objectives:read granted at the deployment root; otherwise 403 permission_denied names the missing permission.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

ownerKind
enum<string>
Available options:
company,
department,
team
ownerRefId
string

Requires ownerKind.

status
enum<string>
Available options:
DRAFT,
ACTIVE,
ARCHIVED
cursor
string

The nextCursor of the previous page, with the same filters.

limit
integer
default:50
Required range: 1 <= x <= 100

Response

List roadmaps

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.