Skip to main content
GET
List projects for planning
Lists the projects you may read at each project’s home as the planning view: each row is the Project with its customer resolution and taskStats (total, completed, and capped, which means the count stopped at the request’s read budget). With customerId it is that customer’s project portfolio. Paging, ordering and filters are exactly List projects’s: limit 1 to 100 (default 50), cursor, status and customerId. Without customerId rows are newest first and status is applied after paging; with customerId rows use status-major index order unless status is also supplied. Pages can be short or empty while meta.hasMore is true; an unreadable cursor answers 400.

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

limit
integer
default:50
Required range: 1 <= x <= 100
cursor
string
Minimum string length: 1
status
enum<string>
Available options:
PLANNING,
ACTIVE,
ON_HOLD,
COMPLETE,
ARCHIVED
customerId
string
Minimum string length: 1

Response

Success

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.