Skip to main content
GET
List workboards

Authorizations

X-API-Key
string
header
required

Owner-typed API key (ORGANIZATION, PERSON, VALUE_UNIT). Manage org-scoped lifecycle with /v1/public-api-keys; cross-org governance is restricted to /v1/sys/public-api-keys.

Query Parameters

scopeType
enum<string>

Optional scope type: PERSON, VALUE_UNIT, or TEAM

Available options:
PERSON,
VALUE_UNIT,
TEAM
scopeId
string

Optional ID of the selected scope

includeStats
boolean
default:false

Include aggregate status counts

_page
integer<int32>

Zero-based offset page (default 0); mutually exclusive with _cursor

Required range: x >= 0
_limit
integer<int32>

Page size from 1 to 100 (default 25)

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

Opaque cursor for the next page; omit on the first page and exclude _page

Response

Matching Workboards

data
object[]
meta
object