Guests

Create a guest

POST
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.
environmentId
stringRequired
Environment ID
email
stringRequired
name
stringRequired
spaces
list of objectsRequired

Response

This endpoint returns an object
data
list of objects
POST
$curl -X POST https://api.x.flatfile.com/v1/guests \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '[
>  {
>    "environmentId": "us_env_YOUR_ID",
>    "email": "email@example.com",
>    "name": "Your Name",
>    "spaces": [
>      {
>        "id": "us_sp_YOUR_ID",
>        "workbooks": [
>          {
>            "id": "us_wb_YOUR_ID"
>          }
>        ],
>        "lastAccessed": "2023-10-30T16:59:45.735Z"
>      }
>    ]
>  }
>]'
Response
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          "lastAccessed": "2023-10-30T16:59:45.735Z"
18        }
19      ],
20      "updatedAt": "2023-10-30T16:59:45.735Z"
21    }
22  ]
23}
Built with