How to Get Chat Channel Members with the ClickUp API

This guide explains how to use the ClickUp public API endpoint to retrieve members of a chat channel, including required scopes, path parameters, and how to work with the response data in your workflow tools or integrations.

Understanding the ClickUp chat channel members endpoint

The API reference endpoint used in this tutorial lets you fetch all members for a specific chat channel in a Workspace. It is designed for developers building apps, automations, or reporting solutions that need to know who belongs to a given conversation.

The reference documentation for this endpoint is available on the official developer site here: Get Chat Channel Members API reference.

Prerequisites for using the ClickUp API

Before you call this endpoint, make sure you have access to the right ClickUp workspace and an app configured in the Developer Platform.

Required access and permissions in ClickUp

• An active ClickUp account.
• Access to the Workspace that owns the chat channel.
• Permission to view the target chat channel and its members.

Required OAuth 2.0 scopes for ClickUp

The endpoint for listing chat channel members requires a specific OAuth 2.0 scope, which must be granted when the user authorizes your app.

• chats:read — allows your app to read chat channels and their members.

When you configure your OAuth consent screen and authorization URL, include this scope so the access token your integration receives will work with the chat channel members endpoint.

Endpoint overview in ClickUp

The endpoint returns all members of a chat channel in a given Workspace. It is a GET request that uses path parameters to identify the Workspace and the specific chat channel.

HTTP method and path

• Method: GET
• Path: /workspaces/{workspace_id}/chats/{chat_id}/members

The base URL depends on the ClickUp API environment you are using, but the path structure remains the same.

Path parameters for ClickUp chat channels

You must provide two path parameters to identify the chat channel:

• workspace_id — the ID of the Workspace where the chat channel exists.
• chat_id — the ID of the chat channel whose members you want to retrieve.

Both IDs are required. If they are invalid or your token does not have access, the request will return an error status code.

How to call the ClickUp chat channel members endpoint

Below is a step-by-step walkthrough to help you prepare and send your request to the ClickUp API.

1. Obtain an access token for ClickUp

1. Create or configure your app in the ClickUp Developer Platform.
2. Implement the OAuth 2.0 authorization flow for your application.
3. Request the chats:read scope during authorization.
4. Exchange the authorization code for an access token.

The returned token should be included in the Authorization header of each API call, using the standard bearer format.

2. Build the ClickUp request URL

Replace the path parameters with real values from your Workspace and chat channel:

• {workspace_id} → workspace identifier.
• {chat_id} → target chat channel identifier.

The final URL structure will look like:

GET /workspaces/123/chats/456/members

3. Add required headers for ClickUp

Set the authorization header so the API can validate your request:

• Authorization: Bearer <access_token>
• Optionally, add Content-Type: application/json where your HTTP client requires it, even though this endpoint uses GET.

4. Send the request and handle responses

After you send the HTTP request, the ClickUp API will respond with a JSON body that contains an array of members, along with associated fields for each user.

Typical handling flow:

1. Parse the JSON response from the API.
2. Loop through the members array.
3. Store or transform the data as needed for your app, automation, or reporting.

Understanding the response from ClickUp

The response includes information about each user who belongs to the chat channel. Although fields can evolve over time, you can expect user identifiers and basic profile data.

Core data you can expect

• User ID or member ID for mapping to other resources.
• Display name or username for UI rendering.
• Additional metadata depending on the current API version.

Use these fields to:

• Show participant lists for chat channels in your integration UI.
• Filter messages by user in your own reports.
• Sync chat membership information with external systems.

Handling errors from the ClickUp endpoint

If something goes wrong, the endpoint returns standard HTTP status codes. Common cases include:

• 401 Unauthorized — missing, expired, or invalid access token.
• 403 Forbidden — token does not have the chats:read scope, or lacks permission to the chat channel.
• 404 Not Found — workspace or chat channel does not exist, or is not accessible to the caller.

Always log both the status code and the response body so you can troubleshoot issues and improve your integration reliability.

Best practices for using ClickUp chat channel data

When working with chat member data, there are several best practices that help keep your integration stable and secure.

Respect privacy and security in ClickUp workspaces

• Only request the chats:read scope when your app truly needs it.
• Avoid storing sensitive member details unless it is necessary for your use case.
• Implement role-based access control within your own system to mirror Workspace visibility.

Optimize performance when calling ClickUp

• Cache results if you repeatedly query the same chat channel.
• Refresh data periodically instead of calling the endpoint on every page load.
• Handle rate limits by backing off and retrying after the suggested delay.

Next steps and additional ClickUp resources

Once you can list chat channel members successfully, you can expand your integration to cover more collaboration scenarios, such as chat histories or Workspace-wide reporting.

For broader guidance on planning and optimizing your workspace integrations and automation strategies, you can review additional resources from Consultevo, which focuses on systems strategy and tooling.

To go deeper into all parameters, status codes, and sample payloads for this endpoint, always refer back to the official ClickUp developer page for chat channel members at Get Chat Channel Members.

By following the steps in this article, you can reliably connect to the correct Workspace, authenticate with the proper scopes, and retrieve structured information about chat channel participants for your ClickUp integrations.