v1

latestOpenAPI 3.1.02026-08-04222461539.5 KB
canvas-areas

List canvas areas

Returns a list of canvas areas filtered by canvas, space, or environment

get/canvas-areas

Query parameters

canvasIdstring

Canvas ID

ID of the canvas to filter areas by

parentIdstring

Canvas Area ID

ID of the parent canvas area to filter by

spaceIdstring

Space ID

ID of the space to filter areas by

environmentIdstring

Environment ID

ID of the environment to filter areas by

pageSizeinteger

Number of areas to return in a page (default 20)

pageNumberinteger

Based on pageSize, which page of areas to return

Headers

Authorizationstring required

Bearer authentication

X-Disable-Hooks'true' required

Response

Response with status 200