Sign in

v1

latestOpenAPI 3.1.02026-07-24172151607.6 KB
Guests

Add Guest To Folder

Share a Folder with a guest.

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

post/v2/folder/{folder_id}/guest/{guest_id}

Path parameters

folder_idnumber required
Example:1057
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

permission_levelstring required

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

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": [],
      "folders": [
        {
          "id": "1057",
          "name": "Folder Name",
          "orderindex": 5,
          "override_statuses": true,
          "hidden": false,
          "task_count": "20",
          "archived": false,
          "statuses": [
            {
              "status": "Open",
              "orderindex": 0,
              "color": "#d3d3d3",
              "type": "open"
            },
            {
              "status": "Closed",
              "orderindex": 5,
              "color": "#6bc950",
              "type": "closed"
            }
          ],
          "lists": [],
          "permission_level": "read"
        }
      ]
    }
  }
}