Skip to main content
GET
Pod planning snapshot

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

startsAt
integer
required

UTC midnight epoch milliseconds; endsAt is exclusive and at lies inside the window.

Required range: x >= 0
endsAt
integer
required

UTC midnight epoch milliseconds; endsAt is exclusive and at lies inside the window.

Required range: x >= 0
at
integer
required

UTC midnight epoch milliseconds; endsAt is exclusive and at lies inside the window.

Required range: x >= 0
cursor
string

Opaque cursor from this exact scope, dates and filters.

limit
integer
default:20

Page size, integer 1–20; defaults to 20.

Required range: 1 <= x <= 20
numItems
integer
default:20

Deprecated alias of limit; when both are sent they must be equal.

Required range: 1 <= x <= 20
query
string

Planning filter.

podId
string

Planning filter.

customerId
string

Planning filter.

deliveryType
enum<string>

Planning filter.

Available options:
msp,
project,
platform,
forward_deployed
categoryKey
string

Planning filter.

stage
enum<string>

Planning filter.

Available options:
pre_deal,
engaged
staffingOrgUnitId
string

Planning filter.

Response

One snapshot, page and continuation

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.