Skip to main content
GET
List worker roles
Lists every worker role (Job) a position can carry, oldest first, in one response without limit, or in pages of limit with cursor. Each role carries id, roleId, name, description, isSystem and isTemplate, plus its timestamps. Its agent configuration (prompt, skills, tool sets, bounds, escalation rules) and its author are never returned. Requires workforce:read at the platform scope, as the Console’s role reads do; a grant that covers only some org units is 403. More than 500 roles is 413 payload_too_large rather than a partial list.

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

Items per page, 1 to 1000; a larger value is a 400 too_big. Omitted, the page is the whole list. The list is read whole.

Required range: 1 <= x <= 1000
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.