List spaces

GET

Returns all spaces for an account or environment

Headers

X-Disable-Hooks"true"Required

Query parameters

environmentIdstringOptional

The ID of the environment.

pageSizeintegerOptional

Number of spaces to return in a page (default 10)

pageNumberintegerOptional

Based on pageSize, which page of records to return

appstringOptional

Filter by appId

searchstringOptional

Search query for spaces

namespacestringOptional

Search by namespace

archivedbooleanOptional

Flag to include archived spaces

sortFieldenumOptional

Field to sort spaces by; requires sortDirection if provided.

sortDirectionenumOptional

Direction of sorting; requires sortField if provided.

Allowed values: ascdesc

isCollaborativebooleanOptional

Flag for collaborative (project) spaces

appIdstringOptionalDeprecated

(Deprecated!) Use app query parameter

isAppTemplatebooleanOptional

Flag for app templates

Response

This endpoint returns an object.

datalist of objects

paginationobjectOptional

pagination info

Errors

GET

1 curl -G https://api.x.flatfile.com/v1/spaces \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -d environmentId=us_env_YOUR_ID

200Example0

1 {
2   "data": [
3     {
4       "createdAt": "2021-01-01T00:00:00.000Z",
5       "guestAuthentication": [
6         "magic_link",
7         "shared_link"
8       ],
9       "id": "us_sp_YOUR_ID",
10       "name": "My First Worbook",
11       "updatedAt": "2021-01-01T00:00:00.000Z",
12       "createdByUserId": "us_usr_YOUR_ID",
13       "displayOrder": 1,
14       "environmentId": "us_env_YOUR_ID",
15       "filesCount": 1,
16       "isCollaborative": true,
17       "labels": [],
18       "lastActivityAt": "2021-01-01T00:00:00.000Z",
19       "metadata": null,
20       "primaryWorkbookId": "us_wb_YOUR_ID",
21       "upgradedAt": "2021-01-01T00:00:00.000Z",
22       "workbooksCount": 1
23     }
24   ],
25   "pagination": {
26     "currentPage": 3,
27     "pageCount": 50,
28     "totalCount": 100
29   }
30 }

Built with

1	curl -G https://api.x.flatfile.com/v1/spaces \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-d environmentId=us_env_YOUR_ID

1	{
2	"data": [
3	{
4	"createdAt": "2021-01-01T00:00:00.000Z",
5	"guestAuthentication": [
6	"magic_link",
7	"shared_link"
8	],
9	"id": "us_sp_YOUR_ID",
10	"name": "My First Worbook",
11	"updatedAt": "2021-01-01T00:00:00.000Z",
12	"createdByUserId": "us_usr_YOUR_ID",
13	"displayOrder": 1,
14	"environmentId": "us_env_YOUR_ID",
15	"filesCount": 1,
16	"isCollaborative": true,
17	"labels": [],
18	"lastActivityAt": "2021-01-01T00:00:00.000Z",
19	"metadata": null,
20	"primaryWorkbookId": "us_wb_YOUR_ID",
21	"upgradedAt": "2021-01-01T00:00:00.000Z",
22	"workbooksCount": 1
23	}
24	],
25	"pagination": {
26	"currentPage": 3,
27	"pageCount": 50,
28	"totalCount": 100
29	}
30	}