Community Create Account Sign in

Overview
API Reference

Community Create Account Sign in

API Reference Guests

Get a guest

GET

GET

1 from flatfile import Flatfile
2 
3 client = Flatfile(
4     token="YOUR_TOKEN",
5 )
6 client.guests.get(
7     guest_id="us_g_YOUR_ID",
8 )

200Example0

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

Returns a single guest

Path parameters

guestIdstringRequired

ID of guest to return

Headers

AuthorizationstringRequired

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

X-Disable-Hooks"true"Required

Response

This endpoint returns an object.

dataobject

Was this page helpful?

Delete a guest