ClickUp Public Page API Guide

The ClickUp Public Page API lets you securely fetch the shared version of a document so you can display or process content that has been made public outside ClickUp. This guide explains how to call the endpoint, use its query parameters, and handle the response correctly.

Understanding the ClickUp Public Page endpoint

The Get Public Page endpoint returns information about a document that has been shared publicly from ClickUp. You can use it to retrieve the current public content and metadata for use in websites, integrations, or internal tools.

This endpoint is designed for read-only access to a shared page. It respects the original sharing settings configured inside ClickUp, so users must generate a public share link for the document before it becomes available through the API.

ClickUp Public Page API URL structure

The endpoint follows a simple REST pattern with a path parameter that identifies the public page. You need to know the public page ID, which is derived from the shared link created inside ClickUp.

Basic structure:

• HTTP method: GET
• Base URL: https://api.clickup.com/api/v2
• Endpoint path: /page/public/{public_page_id}

When combined, your request URL will look like:

GET https://api.clickup.com/api/v2/page/public/{public_page_id}

Replace {public_page_id} with the ID from the shared page link generated in ClickUp.

Authentication for ClickUp Public Page

The public page API is intended for content that has already been shared via a public link. Depending on your implementation, you may still need to send an API token in the request header as documented in the broader ClickUp API reference.

Typical header structure:

• Authorization: pk_<your_token> (format may vary based on your token)
• Content-Type: application/json (recommended)

Always keep your token secret and avoid embedding it directly in client-side code. Instead, route your ClickUp API calls through a secure backend service.

Required path parameter: public_page_id

The only required path parameter is the public_page_id that identifies the shared document in ClickUp.

• public_page_id: A string that uniquely represents the publicly shared page.

To obtain this ID, generate a public share link for the page inside ClickUp, then extract the identifier portion from that URL as described in the official API documentation at the ClickUp Public Page reference.

Optional query parameters for ClickUp Public Page

The endpoint supports several query parameters that control the format and extent of the returned data. These options help you optimize bandwidth and processing depending on how you intend to use the document content.

ClickUp content format controls

You can choose how the document content is formatted in the response. Use these query parameters to adjust what ClickUp returns:

• include_html: Set to true to return the page content rendered as HTML.
• include_markdown: Set to true to return the content in Markdown format.
• include_raw: Set to true to return the raw structured content blocks used internally by ClickUp.

Only request the formats you actually need. For example, if you just want to display the page on a website, you might only set include_html=true.

ClickUp metadata and structure options

Beyond content formatting, the API lets you choose whether to include additional metadata and structural details from ClickUp:

• include_comments: When true, the response can include public comments associated with the page.
• include_attachments: When true, attachment metadata that belongs to the shared document can be returned.
• include_history: When true, limited revision or activity information related to the public page can be included, depending on the current capabilities described in the ClickUp documentation.

Review the official endpoint reference to confirm which of these options are currently available and how each field is represented.

Step-by-step: calling the ClickUp Public Page API

Follow these steps to make a successful request to the public page endpoint in ClickUp:

1. Enable public sharing in ClickUp

1. Open the document or page in your ClickUp Workspace.
2. Locate the sharing or public link settings for the page.
3. Enable public sharing and copy the generated share link.

Without this step, the API will not be able to return content because the page is not accessible as a public page in ClickUp.

2. Extract the public_page_id from the share link

1. Paste the share URL into a text editor.
2. Identify the portion of the URL that represents the page identifier.
3. Use this identifier as the {public_page_id} path parameter in your API request.

The format of the public link may vary over time, so confirm the exact extraction method using the official ClickUp documentation.

3. Choose your ClickUp query parameters

1. Decide whether you need HTML, Markdown, or raw blocks.
2. Determine if you must include comments or attachments.
3. Add the relevant query parameters to the request URL, for example: ?include_html=true&include_comments=false.

By limiting the parameters to only what you need, you make your ClickUp integration faster and easier to maintain.

4. Send the HTTP GET request

1. Construct the full URL: https://api.clickup.com/api/v2/page/public/{public_page_id}?include_html=true.
2. Set the appropriate headers, such as Authorization and Content-Type.
3. Send the request using your preferred HTTP client, server-side language, or API tool.

If the page is valid and publicly shared, ClickUp will return a JSON response that includes the requested content and metadata.

5. Handle the ClickUp API response

The response from the public page endpoint will typically include:

• Basic page identifiers and metadata.
• Content fields that correspond to the formats you requested (HTML, Markdown, or raw blocks).
• Optional structures for comments, attachments, or history if enabled by your query parameters.

Parse the response carefully and sanitize or filter content before displaying it in your application, particularly if you render HTML directly from ClickUp.

Use cases for the ClickUp Public Page API

The public page endpoint supports several valuable scenarios where content from ClickUp needs to live outside the workspace.

• Knowledge base pages: Render ClickUp documents directly into a public support or documentation site.
• Client portals: Surface shared project summaries or briefs that are maintained inside ClickUp, while clients see a branded external interface.
• Content pipelines: Use ClickUp documents as a source of truth and ingest them into publishing workflows or static site generators.
• Internal dashboards: Aggregate public strategic documents into an intranet, without granting wide workspace access in ClickUp.

In each case, the ClickUp API helps ensure the content shown externally stays synchronized with the latest public version maintained in the app.

Best practices for ClickUp Public Page integrations

When working with public page data from ClickUp, follow these best practices:

• Cache responses: Cache public page content for a period of time to reduce repeated calls to ClickUp and improve performance.
• Respect privacy: Only share or display content that has been intentionally made public in ClickUp.
• Monitor errors: Handle HTTP status codes and API errors gracefully so that unavailable or revoked pages do not break your interface.
• Limit exposure: Do not rely solely on obscurity of the public_page_id; keep any sensitive data within secured areas of ClickUp and avoid publishing it.

Further ClickUp resources and optimization help

For exact field definitions, example responses, and the latest parameter list, review the official reference for the Get Public Page endpoint at the ClickUp API documentation.

If you need help designing a robust integration architecture, API strategy, or SEO-focused content workflow that uses ClickUp as a source of truth, you can find specialized consulting services at Consultevo.

By combining these best practices with a clear understanding of the public page endpoint, you can safely extend ClickUp content into websites, client portals, and automation systems while keeping your workspace structured and secure.

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

“`