v1
latestOpenAPI 3.1.02026-07-24172151607.6 KBGuests
Add Guest To List
Share a List with a guest.
Note: This endpoint is only available to Workspaces on our Enterprise Plan.
post/v2/list/{list_id}/guest/{guest_id}
Path parameters
list_idnumber required
Example:1427
guest_idnumber required
Example:403
Query parameters
include_sharedboolean
Exclude details of items shared with the guest by setting this parameter to false. By default this parameter is set to true.
Request body
Example request
{
"permission_level": "read"
}Response
Example response
{
"guest": {
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"shared": {
"tasks": [],
"lists": [
{
"id": "1427",
"name": "List Name",
"orderindex": 1,
"status": null,
"priority": null,
"assignee": null,
"task_count": "5",
"due_date": null,
"start_date": null,
"archived": false,
"override_statuses": true,
"statuses": [
{
"status": "Open",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "Closed",
"orderindex": 5,
"color": "#6bc950",
"type": "closed"
}
],
"permission_level": "read"
}
],
"folders": []
}
}
}