List canvas areas

GET

1 curl https://api.x.flatfile.com/v1/canvas-areas \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>"

Play

200Retrieved

1 {
2   "data": [
3     {
4       "id": "id",
5       "canvasId": "canvasId",
6       "config": {
7         "key": "value"
8       },
9       "metadata": {
10         "key": "value"
11       },
12       "layout": "split",
13       "overlay": {
14         "key": "value"
15       },
16       "type": "mapping",
17       "position": "top",
18       "visibility": "visible",
19       "createdAt": "2024-01-15T09:30:00Z",
20       "updatedAt": "2024-01-15T09:30:00Z",
21       "parentId": "parentId",
22       "deletedAt": "2024-01-15T09:30:00Z"
23     },
24     {
25       "id": "id",
26       "canvasId": "canvasId",
27       "config": {
28         "key": "value"
29       },
30       "metadata": {
31         "key": "value"
32       },
33       "layout": "split",
34       "overlay": {
35         "key": "value"
36       },
37       "type": "mapping",
38       "position": "top",
39       "visibility": "visible",
40       "createdAt": "2024-01-15T09:30:00Z",
41       "updatedAt": "2024-01-15T09:30:00Z",
42       "parentId": "parentId",
43       "deletedAt": "2024-01-15T09:30:00Z"
44     }
45   ],
46   "pagination": {
47     "currentPage": 1,
48     "pageCount": 1,
49     "totalCount": 1
50   }
51 }

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

Query parameters

canvasIdstringOptional

ID of the canvas to filter areas by

parentIdstringOptional

ID of the parent canvas area to filter by

spaceIdstringOptional

ID of the space to filter areas by

environmentIdstringOptional

ID of the environment to filter areas by

pageSizeintegerOptional

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

pageNumberintegerOptional

Based on pageSize, which page of areas to return

Response

This endpoint returns an object.

datalist of objects

paginationobjectOptional

pagination info

List canvas areas

Headers

Query parameters

Response

Errors