Add Guest To List

Share a List with a guest.

Note: This endpoint is only available to Workspaces on our Enterprise Plan.

SecurityAuthorization_Token
Request
path Parameters
list_id
required
number <double>
guest_id
required
number <double>
query Parameters
include_shared
boolean

Exclude details of items shared with the guest by setting this parameter to false. By default this parameter is set to true.

Request Body schema: application/json
required
permission_level
required
string

Can be read (view only), comment, edit, or create (full).

Responses
200
post/v2/list/{list_id}/guest/{guest_id}
Request samples
application/json
{
  • "permission_level": "read"
}
Response samples
application/json
{
  • "guest": {
    }
}