Whimsical API (Beta)

The Whimsical API makes it possible to integrate Whimsical with other tools, access your content programmatically, and build custom workflows on top of your workspace.

⚠️ The API is currently in beta and under active development. Capabilities are limited, and new features will be added over time. If you’d like access or have feedback, please contact our support team.

EndpointsCopied!Link to this section

The current API is read-only and focused on retrieving workspace content. These are the currently available endpoints:

UsersCopied!Link to this section

POST /users.get

Returns information about a user, given their user ID.

TeamsCopied!Link to this section

POST /teams.list

Returns a list of all teams in the workspace.

ProjectsCopied!Link to this section

POST /projects.list

Returns a list of projects in a team, given the team ID.

PostsCopied!Link to this section

POST /posts.list

Returns a list of all posts in a project or team, given the team or project ID.

CommentsCopied!Link to this section

POST /comments.list

Returns a list of all comments on an item, given the item ID.

FilesCopied!Link to this section

POST /files.list

Returns a list of all files within a file, folder, section, or team, given the ID of the parent item.

POST /files.get

Returns information about a file, given the file ID. Optionally returns file content as HTML or markdown (for docs only, board content is not yet supported).

BlocksCopied!Link to this section

POST /blocks.list

Returns a list of blocks within a doc, given the file ID. Markdown or HTML available.

AuthenticationCopied!Link to this section

The Whimsical API uses OAuth 2.1 for authentication and authorization. If your workspace is approved for the limited API beta - we will provide the required secrets to authenticate with OAuth.

FeedbackCopied!Link to this section

This is just the beginning. We’d love to hear what you’re hoping to build with Whimsical's API and what endpoints you’d like to see next.

Please feel free to share your feedback with us here. 👍