Spaces

Get a space

GET
Returns a single space

Path parameters

spaceIdstringRequired
ID of space to return

Response

This endpoint returns an object
data
object
A place to store your workbooks

Errors

GET
$curl https://api.x.flatfile.com/v1/spaces/us_sp_YOUR_ID \
>     -H "Authorization: Bearer <token>"
Response
1{
2  "data": {
3    "createdAt": "2021-01-01T00:00:00.000Z",
4    "guestAuthentication": [
5      "magic_link",
6      "shared_link"
7    ],
8    "id": "us_sp_YOUR_ID",
9    "name": "My First Worbook",
10    "updatedAt": "2021-01-01T00:00:00.000Z",
11    "createdByUserId": "us_usr_YOUR_ID",
12    "displayOrder": 1,
13    "environmentId": "us_env_YOUR_ID",
14    "filesCount": 1,
15    "isCollaborative": true,
16    "labels": [],
17    "lastActivityAt": "2021-01-01T00:00:00.000Z",
18    "metadata": null,
19    "primaryWorkbookId": "us_wb_YOUR_ID",
20    "upgradedAt": "2021-01-01T00:00:00.000Z",
21    "workbooksCount": 1
22  }
23}
Built with