Exploring your Workspace
The ClickUp API uses the same ClickUp Hierarchy to help you explore your Workspaces.
Find Workspaces
Use the Get Authorized Teams endpoint to list the Workspaces you've created or joined.
You'll use theteam (Workspace) id
from the response to:- Navigate the hierarchy
- Find tasks across your Workspace using the Get Filtered Team Tasks endpoint.
We'll use the Workspace ID to explore the Hierarchy.
Find Spaces
Use the Get Spaces endpoint to list each Space in a Workspace. The Spaceid
is needed to find specific Folders and Folderless Lists.You'll need to find Workspaces first! We need the team ID to identify the Workspace.
Find Folders
Use the Get Folders endpoint to list each Folder in a Space. The Folderid
is needed to find Lists within the Folder.You'll need to find Spaces first. We need the Space ID to identify the Space.
Find Lists
Lists can exist in Folders or Spaces. Searching in a Folder or Space for a List is handled by two different endpoints.
Find Folderless Lists
Use the Get Folderless Lists endpoint to find Folderless Lists in a Space.
You'll need to find Spaces first! We need the Space ID to identify the Space.
Find Lists in Folders
Use the Get Lists endpoint to find the Lists in a Folder.
You'll need to find Folders first! We need the Folder ID to identify the Folder.
id
to find tasks in a List or access Custom Fields via Custom Fields via Get Accessible Custom Fields.Find Tasks
Use the Get Tasks endpoint to find tasks in a List.
You'll need to find Lists first! We need the List ID to identify the List.