Guests

List guests

GET
Returns all guests

Query parameters

spaceIdstringRequired
ID of space to return
emailstringOptional
Email of guest to return

Response

This endpoint returns an object
data
list of objects
GET
$curl -G https://api.x.flatfile.com/v1/guests \
> -H "Authorization: Bearer <token>" \
> -d spaceId=us_sp_YOUR_ID
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}