CLclickup
Guests

Remove Guest From List

Changed on

Revoke a guest's access to a List.

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

delete/v2/list/{list_id}/guest/{guest_id}

Request

  • Base URL
    https://api.clickup.com/api
  • URL
    https://api.clickup.com/api/v2/list/{list_id}/guest/{guest_id}
  • Auth
    API key in header Authorization

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.

Response

guestGuest required(unresolved $ref)

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

Changes

  • a0a72ec97ddbRevision changes
    • breaking

      the response's property type changed from no type to object for status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status