Add Guest To List

Nothing Found

Help Center
API Feature Requests

Nothing Found

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

permission_level

required

string

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

Responses

200

post/list/{list_id}/guest/{guest_id}

Request samples

application/json

{"permission_level": "read"
}

Response samples

application/json

{"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://dev-attachments-public.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": [ ]
}
}
}

© 2022 ClickUp
Security
Your Privacy
Terms