How to Use the ClickUp Public Doc API Endpoint

The ClickUp Public Doc API endpoint lets you securely retrieve the content of a public document using a simple HTTP request, making it easy to integrate ClickUp documentation into your own apps, sites, or internal tools.

This guide walks you step by step through how the endpoint works, how to authenticate, what parameters are required, and how to interpret the response using only the details from the official reference.

What the ClickUp Public Doc Endpoint Does

The Get Public Doc endpoint provides read-only access to a single document that has been shared publicly from a ClickUp workspace.

With this endpoint you can:

• Fetch the latest content for a public document.
• Use a share token in the URL path to identify the doc.
• Optionally pass a passcode to access protected docs.
• Work with a documented JSON response structure.

The endpoint is designed for secure access to public content, not for editing or managing docs in ClickUp.

ClickUp Public Doc Endpoint Overview

The reference describes one HTTP method for this feature:

• Method: GET
• Endpoint: /v3/public/docs/{token}
• Base URL: Determined by your ClickUp API environment

The {token} in the path is the share token generated when a document is made public in ClickUp. Without a valid token, the request will fail.

Authentication and Security in ClickUp Public Docs

The public doc endpoint supports authentication through the ClickUp public API security scheme. According to the reference, you must use an API token and ensure it has the correct permissions and scopes enabled.

Required Permissions and Scopes in ClickUp

Your API token must be configured in ClickUp with:

• Permission: public:doc:read
• OAuth Scope: public:doc

Without this permission and scope, the request to read public documents will be rejected.

Passing Authentication to the ClickUp API

The reference assumes standard API authentication patterns. Typically, you will:

• Include your token in the HTTP header following the ClickUp API guidelines.
• Ensure the token belongs to a workspace that can access the public document.
• Store the token securely in your application or integration.

Request Parameters for the ClickUp Public Doc Endpoint

The endpoint uses a combination of path and query parameters to identify and open the correct document.

Path Parameter: Token

• Name: token
• Location: Path (in /v3/public/docs/{token})
• Type: String
• Required: Yes

The token is the unique identifier you copy from the public share link inside ClickUp.

Query Parameter: Passcode for ClickUp Public Docs

• Name: passcode
• Location: Query string
• Type: String
• Required: No, only needed for passcode-protected docs

If the ClickUp document is protected with a passcode, you must supply that passcode as a query parameter in the request. If the doc has no passcode, you can omit this parameter.

Step-by-Step: Call the ClickUp Public Doc API

Follow these high-level steps to call the endpoint based on the reference specification.

1. Prepare Your ClickUp API Token

1. Obtain an API token from your ClickUp account or OAuth app.
2. Confirm the token includes the public:doc:read permission.
3. Ensure the OAuth scope public:doc is granted if you are using OAuth.

2. Get the ClickUp Public Doc Token

1. Open the document inside ClickUp.
2. Enable public sharing for that document.
3. Copy the share link and extract the share token portion from the URL.

This token becomes the {token} path parameter in the API route.

3. Build the Request URL

Combine the base URL, route, and parameters:

• Start with the ClickUp API base URL.
• Append /v3/public/docs/{token}.
• Add ?passcode=YOUR_PASSCODE to the query string if needed.

Your final URL will look like a standard ClickUp API endpoint but targeted specifically at the public doc resource identified by the token.

4. Send the HTTP GET Request

1. Use your preferred HTTP client (CLI, code library, or REST tool).
2. Set method to GET.
3. Add the required authentication header with your ClickUp token.
4. Send the request to the constructed URL.

If the token, permission, and optional passcode are correct, the server will return a JSON response describing the public document.

Understanding the ClickUp Public Doc Response

The response schema is defined under ReadPublicDocResponse in the specification. It includes information that represents the public document and its related metadata.

The reference links this response to a component schema so that integrators can rely on a consistent, versioned structure when working with public documents from ClickUp.

Common Uses for ClickUp Public Doc Data

Once you receive a successful response, you can use it in several ways:

• Display the document content on a website or internal dashboard.
• Sync public docs into another knowledge base.
• Search or index public docs in your own systems.

Because the endpoint is defined in the ClickUp reference, it is stable and suitable for production integrations.

Error Handling with the ClickUp Public Doc Endpoint

While the page focuses on structure rather than error codes, typical failure cases can include:

• Invalid or missing token in the path.
• Wrong or missing passcode for protected docs.
• Insufficient permissions or scope on the ClickUp API token.

Your integration should check HTTP status codes, log any error responses, and surface clear messages to users if the document cannot be loaded.

Official ClickUp Reference and Further Help

For the most precise and updated details about this endpoint, always refer directly to the official ClickUp developer documentation here: ClickUp Get Public Doc reference.

If you need strategic guidance on implementing this endpoint in a larger integration, analytics pipeline, or SEO-focused documentation system, you can also consult experts at Consultevo, who specialize in technical implementation and optimization.

Summary: Integrating ClickUp Public Docs

The public doc endpoint is a focused, secure way to read external-facing documents from ClickUp using a token, optional passcode, and clearly defined scopes. By following the reference specification, you can reliably fetch, display, and reuse public documentation while respecting workspace security and access controls.

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

“`