Skip to main content
GET
List a worker's bandwidth feedback
Returns up to limit (1 to 50, default 20) of one worker’s bandwidth reports, newest first; workerId is required, and weekOf narrows to one week as the report recorded it. Page with limit and cursor. Needs workforce:read at the platform scope (Console parity): a grant that covers only some org units receives 403. A report never names who responded.

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

workerId
string
required

The worker seat the reports are about.

Minimum string length: 1

Query Parameters

weekOf
string

Only reports for this week (as the report recorded it).

Minimum string length: 1
limit
integer
default:20

How many of the top items to answer, 1 to 50 (default 20); a larger value is a 400 too_big. The list is bounded: at most 50 items, the worker's newest limit reports. Every answer is the whole list, so meta.hasMore is false.

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

A bounded list issues no cursor: meta.nextCursor is always null, and any cursor 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.