Access and edit Docs via the API
complete
Log In
Brent
complete
Hi all, we're thrilled to announce that the Docs API is now public!
Please see our documentation for information on how to search, create, fetch, and edit Docs and pages: https://clickup.com/api/
We're still listening to your feedback and exploring additional functionalities. Please be sure to keep voting for existing posts, and creating new posts when one doesn't already exist, here on Canny. We'd love to keep hearing about how this helps your workflow, and enhancements that you'd like to see!
Koos Vis
Brent Could you send some instruction on how we can use API for Docs so we can 'Read' them and save a copy to our Google Drive. Mindset: backup of all our SOPs. Thanks
Brent
Hi Koos Vis, this page in our API documentation guide can help get content from all pages in a Doc, that you could then back up.
Please let me know if you were thinking about something else here. Thanks!
Koos Vis
Hi Brent
Thank you for sharing the details. I’ve reviewed them, but it seems a few items for the API might be missing. Please correct me if I’m mistaken. (For context, we use MAKE for our automation.)
Here’s the weekly backup process we’re envisioning:
- Trigger: Every Monday at 5 AM, search the "SOP Documents" folder for any pages updated within the last 7 days (based on the 'Last Updated' date).
- Folder Creation: If changes are detected, create a new folder in the "SOP BACKUP" directory on Google Drive, naming the folder with the current date.
- Document Backup: For each changed page, generate a new Google Doc.
- Copy all content (including text, graphics, and links) into the new document while maintaining the original format.
Does this align with what’s currently supported by the API? If not, how can we make this work?
Looking forward to your feedback.
Brent
Hi Koos Vis, thanks for following up with additional details about your envisioned process!
ClickUp's API includes a Search Docs endpoint, which allows you to specify a Folder ID and retrieve metadata for all Docs in that folder. The response includes a date_updated field with a timestamp you could use to identify Docs updated within the last 7 days.
The ClickUp API can also retrieve the content of each page using the Get Doc Pages endpoint.
Filtering Docs by 'Last Updated' within the past 7 days isn't a parameter currently supported directly by the API. That filtering and Google Drive folder/Doc creation could be explored in MAKE.
I hope this helps to provide clarity on ways the ClickUp API can support your workflows!
Koos Vis
Brent Thank you. Will get to work on this.
Michael Montefusco
Amazing!!
Just a heads up. ON the Postman Collection the link to the full collection JSON file is broken. It only hyperlinked the first half and you need to copy the whole thing to get the file.
Brent
complete
Hi all, we're thrilled to announce that the Docs API is now public!
Please see our documentation for information on how to search, create, fetch, and edit Docs and pages: https://clickup.com/api/
We're still listening to your feedback and exploring additional functionalities. Please be sure to keep voting for existing posts, and creating new posts when one doesn't already exist, here on Canny. We'd love to keep hearing about how this helps your workflow, and enhancements that you'd like to see!
Hiran Ganegedara
Requesting access to the beta API please. Thanks.
K
Keyston Clay
Asking for beta access to the new API please. Thanks
Brent
in progress
Hi all, thanks so much for your feedback and interest in Docs API. While the beta is now closed, we have been using this feedback to make improvements ahead of release in the coming weeks. We'll be sure to provide updates on this post as we look forward to launching Docs API!
Scott
Hey Brent, could you give us an idea of what we should expect from the API?
The ClickUp docs lead you to believe it's Markdown that you're writing but I have a feeling that the API will give us Rich Text AST like response
I want to know what the read output will be from the API will be, will it be limited, have pagination etc?
thanks
P
Phil Martin
Brent that is so exciting. In the coming weeks makes it very exciting! Much better than 2025 :D
Brent
Hi Scott, here are some features from the API that we're targeting for release:
- Search your Workspace and use filters to find specific Docs.
- Create new Docs.
- Get metadata about each specific Doc including a list of pages.
- Get content of all the pages and subpages in a Doc.
- Create pages within Docs.
- Get the content of single page.
For page content, markdown and plaintext formats can be requested. Please keep in mind that we're still developing these features and there may be changes.
Bryan McAnulty
Brent this sounds great! My team desperately needs this.
Thierry Fournier
Hello, also interested by the beta access to DOC API.
V
Vivek Bhaugeerutty
Hey ! Can we also get access to Docs API's BETA ?
G
Gichu Dakta
Hi... how can get access to the beta access for the Docs API?
E
Ernest Mucheru
Hello, I'm requesting for beta access to the Docs API.
Load More
→