Skip to navigation

List boards

View as Markdown

Returns one page of boards, most recently updated first. Each board carries its tag; group by that field if you need a tag view. Tabs, widgets and filters are not included.

Path parameters

org_idstringRequired
Organization ID
workspace_idstringRequired
Workspace ID

Headers

X-API-KeystringRequired
Your workspace API key.

Query parameters

limitintegerOptional1-100Defaults to 50

Maximum boards to return: 1 to 100, default 50

offsetintegerOptional>=0Defaults to 0
Number of boards to skip before this page

Response

Successful Response
itemslist of objects
One page of boards, most recently updated first
totalinteger
Number of boards in the workspace
limitinteger

The limit applied to this page

offsetinteger

The offset applied to this page

next_page_uristring or nullOptional

Always null; page with offset and total instead

prev_page_uristring or nullOptional

Always null; page with offset and total instead

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error