Create a guest

POST

https://api.x.flatfile.com/v1/guests

POST

/v1/guests

1 curl -X POST https://api.x.flatfile.com/v1/guests \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '[
6   {
7     "environmentId": "us_env_YOUR_ID",
8     "email": "email@example.com",
9     "name": "Your Name",
10     "spaces": [
11       {
12         "id": "us_sp_YOUR_ID",
13         "workbooks": [
14           {
15             "id": "us_wb_YOUR_ID"
16           }
17         ],
18         "sheets": [
19           {
20             "id": "us_sh_YOUR_ID"
21           }
22         ],
23         "lastAccessed": "2023-10-30T16:59:45.735Z"
24       }
25     ]
26   }
27 ]'

Try it

200Example0

1 {
2   "data": [
3     {
4       "createdAt": "2023-10-30T16:59:45.735Z",
5       "email": "email@example.com",
6       "environmentId": "us_env_YOUR_ID",
7       "id": "us_g_YOUR_ID",
8       "name": "Your Name",
9       "spaces": [
10         {
11           "id": "us_sp_YOUR_ID",
12           "workbooks": [
13             {
14               "id": "us_wb_YOUR_ID"
15             }
16           ],
17           "sheets": [
18             {
19               "id": "us_sh_YOUR_ID"
20             }
21           ],
22           "lastAccessed": "2023-10-30T16:59:45.735Z"
23         }
24       ],
25       "updatedAt": "2023-10-30T16:59:45.735Z"
26     }
27   ]
28 }

Guests are only there to upload, edit, and download files and perform their tasks in a specific Space.

Request

This endpoint expects a list of objects.

environmentIdstringRequired

Environment ID

emailstringRequired

namestringRequired

spaceslist of objectsRequired

Response

This endpoint returns an object.

datalist of objects

Headers

Request

Response