v1

latestOpenAPI 3.1.02026-07-24172151607.6 KB

Guests

Remove Guest From Task

Revoke a guest's access to a task.

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

delete/v2/task/{task_id}/guest/{guest_id}

Path parameters

task_idstring required

Example:c04

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.

custom_task_idsboolean

Example:true

If you want to reference a task by it's custom task id, this value must be true.

team_idnumber

Example:123

When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter.
For example: custom_task_ids=true&team_id=123.

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": []
    }
  }
}