Community Create Account Sign in

Overview
API Reference

Community Create Account Sign in

API Reference Guests

List guests

GET

GET

1 from flatfile import Flatfile
2 
3 client = Flatfile(
4     token="YOUR_TOKEN",
5 )
6 client.guests.list(
7     space_id="us_sp_YOUR_ID",
8 )

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           "lastAccessed": "2023-10-30T16:59:45.735Z"
18         }
19       ],
20       "updatedAt": "2023-10-30T16:59:45.735Z"
21     }
22   ]
23 }

Returns all guests

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-Disable-Hooks"true"Required

Query parameters

spaceIdstringRequired

ID of space to return

emailstringOptional

Email of guest to return

Response

This endpoint returns an object.

datalist of objects

Was this page helpful?

Create a guest