Skip to main content
GET
List the pods (teams) that work for a Customer
Lists the Customer’s pod assignments that overlap the window startsAt–endsAt (UTC day boundaries, endsAt exclusive), each with its pod and verification state. Assignments of pods managed by or under a customer organization are omitted and never named. The assignments come a page at a time, oldest effective end first: limit is 1-100, default 100, and a larger value is 400 too_big. While meta.hasMore is true, pass meta.nextCursor as cursor with the same other parameters; a cursor from another route, other parameters or another credential, or altered, is 400. A row of a hidden pod, or one that starts after the window ends, is left out after the read, so a page may hold fewer than limit, or none, while more remain. An unknown Customer returns 404. It requires workforce:read at the platform scope; no customers:read is needed.

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.

Path Parameters

customerId
string
required
Minimum string length: 1

Query Parameters

startsAt
integer
required

Window start, a UTC day boundary (epoch ms).

Required range: x >= 0
endsAt
integer
required

Exclusive window end, a UTC day boundary (epoch ms), after startsAt.

Required range: x >= 0
limit
integer
default:100

Items per page, 1 to 100 (default 100); a larger value is a 400 too_big. A page may hold fewer items than limit while meta.hasMore is true; continue with meta.nextCursor.

Required range: 1 <= x <= 100
cursor
string

The previous page's meta.nextCursor; any other value is 400.

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.