How to Remove a Guest from a Folder in ClickUp via API

This step-by-step guide explains how to remove a guest from a Folder in ClickUp using the official REST API endpoint, including required scopes, path parameters, and example requests.

Overview of the ClickUp Folder Guest Removal Endpoint

The ClickUp API provides a dedicated endpoint to remove a guest from a specific Folder in a Workspace. This operation revokes the guest’s access to that Folder while leaving their overall guest status and other permissions intact.

The endpoint is:

DELETE /api/v2/folder/{folder_id}/guest/{guest_id}

This method uses the HTTP DELETE verb and requires valid authentication and permissions.

Prerequisites for Using the ClickUp API

Before you call the Folder guest removal endpoint in ClickUp, make sure the following prerequisites are met:

• You have an active ClickUp Workspace with the Folder and guest already set up.
• You have a valid ClickUp API token with the correct OAuth scopes.
• You know the folder_id of the Folder and the guest_id of the guest you want to remove.

Required ClickUp OAuth Scope

The endpoint requires the following scope:

• manage:guest

Without this scope, the ClickUp API will return an error and the guest removal action will not be performed.

Understanding Path Parameters in the ClickUp Endpoint

The guest removal endpoint uses two path parameters in the URL. Both are required and must be correctly formatted.

folder_id Parameter

The folder_id represents the unique identifier of the Folder from which you want to remove the guest in ClickUp.

• Data type: string
• Location: URL path
• Example: /folder/123

guest_id Parameter

The guest_id is the unique identifier for the guest you are removing from the Folder in ClickUp.

• Data type: string
• Location: URL path
• Example: /guest/321

Combined, the URL structure looks like this:

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

Step-by-Step: Remove a Guest from a Folder in ClickUp

Follow these steps to call the endpoint and remove a guest from a Folder using the ClickUp API.

1. Collect Required IDs

First, gather the identifiers used in the endpoint:

• Folder ID: the target Folder where the guest currently has access.
• Guest ID: the guest whose access to that Folder you want to revoke in ClickUp.

You can retrieve these IDs from other ClickUp API endpoints or from your Workspace interface, depending on your setup and tooling.

2. Set Up Authentication Headers

The request must include an Authorization header with your ClickUp API token. Make sure you send:

Authorization: Bearer <your_api_token>

Confirm that the token has the manage:guest scope; otherwise, the request will fail.

3. Build the DELETE Request URL

Insert your actual IDs into the endpoint path. For example:

DELETE https://api.clickup.com/api/v2/folder/123/guest/321

Replace 123 with your real folder_id and 321 with your real guest_id values from ClickUp.

4. Send the DELETE Request

You can send the request using tools like curl, Postman, or within your application code.

Example using curl:

curl -X DELETE 
  https://api.clickup.com/api/v2/folder/123/guest/321 
  -H "Authorization: Bearer <your_api_token>"

The ClickUp API processes this call and, if successful, removes the guest from the specified Folder.

Handling Responses from the ClickUp API

The documentation for this endpoint focuses on how to structure the request. While the exact response body is not detailed on the reference page, you should generally expect standard HTTP status codes.

Common Response Patterns

• 2xx Success: Indicates that the guest has been successfully removed from the Folder in ClickUp.
• 4xx Client Errors: May indicate invalid IDs, missing authentication, or insufficient scopes.
• 5xx Server Errors: Suggest temporary issues on the ClickUp side; you may retry later.

In your integration, handle these status codes appropriately and log the response for troubleshooting.

Best Practices for Using the ClickUp Guest Removal Endpoint

To keep your integrations stable and secure, consider the following best practices when you remove Folder guests through the ClickUp API.

Validate IDs Before Sending Requests

Implement validation in your application to ensure the folder_id and guest_id values exist and are correctly formatted before calling the ClickUp endpoint. This reduces unnecessary failed requests.

Respect Least-Privilege Access

Limit your ClickUp API token scopes only to what your integration needs. Use manage:guest strictly for functionalities that involve updating or removing guest access.

Log Activity for Auditing

When building admin tools around ClickUp, log every guest removal event. Track:

• Which Folder was affected.
• Which guest ID was removed.
• Which user or system triggered the request.
• The HTTP status code returned by ClickUp.

Example Use Cases for ClickUp Folder Guest Removal

The guest removal endpoint can help automate Workspace management workflows. Some example scenarios include:

• Automatically revoking a contractor’s Folder access after a project ends in ClickUp.
• Synchronizing third-party user access lists with Folders via scheduled scripts.
• Cleaning up unused guest access when restructuring project Folders.

In each case, your system calls the ClickUp endpoint whenever access rules change, ensuring permissions remain up to date.

Where to Find the Official ClickUp API Reference

For the most accurate and current details about this endpoint, including any future changes, consult the official ClickUp developer documentation:

Remove Guest from Folder API Reference

This page is the canonical source for parameters, scopes, and request examples related to Folder guest removal in ClickUp.

Improving Your ClickUp Integrations

If you are building complex automation, custom dashboards, or AI-powered functionality around ClickUp, you may benefit from implementation guidance and integration strategy support.

For broader consulting on workflow design, SEO-aware documentation, and API integration patterns, you can explore resources at Consultevo. Apply these concepts to design robust, maintainable systems on top of the ClickUp platform.

Summary: Managing Folder Guests with the ClickUp API

To remove a guest from a Folder using the ClickUp API, you must:

1. Obtain a token with the manage:guest scope.
2. Collect the correct folder_id and guest_id.
3. Send an authenticated DELETE request to /api/v2/folder/{folder_id}/guest/{guest_id}.

By following the structure described in the official reference and this guide, you can reliably remove Folder guests and maintain precise access control across your ClickUp Workspace.

Need Help With ClickUp?

If you want expert help building, automating, or scaling your ClickUp workspace, work with ConsultEvo — trusted ClickUp Solution Partners.

Get Help

“`