Skip to main content
GET
List pods
Lists pods in podKey order with effective lead and member counts at at. Query limit (default 25, max 25), cursor, status (active or archived, default active), managingOrgUnitId and at. A page is short or empty only when it is the last page; continue with meta.nextCursor while meta.hasMore is true. Pods managed by or under a customer organization are omitted, and the cursor never names one. A grant below the platform scope returns 403.

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:25
Required range: 1 <= x <= 25
cursor
string
Minimum string length: 1
status
enum<string>
default:active
Available options:
active,
archived
managingOrgUnitId
string
Minimum string length: 1
at
integer

Evaluation time (epoch ms); defaults to the request time.

Required range: x >= 0

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.