Skip to content

Plane API Documentation โ€‹

Complete API reference for Plane v0.25.3.

๐Ÿ” Authentication

Sign-in, sign-up, magic links, OAuth, and password management

Get started โ†’

๐Ÿข Workspace

Workspaces, members, invitations, labels, states

Explore โ†’

๐Ÿ“ Project

Projects, members, invitations, deploy boards

Explore โ†’

๐Ÿ“‹ Issues

Issues, comments, attachments, links, sub-issues, reactions

Explore โ†’

๐Ÿ”„ Cycles

Sprint-like timeboxes for organizing work

Explore โ†’

๐Ÿ“ฆ Modules

Group related issues into functional deliverables

Explore โ†’

๐Ÿ“„ Pages

Wiki-style documentation within projects

Explore โ†’

๐Ÿ”Œ External API

RESTful API v1 for integrations and external tools

Explore โ†’

Key Features โ€‹

  • Session-based auth for internal API (/api/)
  • API Key auth for external API (/api/v1/) with X-API-Key header
  • Cursor-based pagination using value:offset:is_prev format
  • Rate limiting at 60 requests/minute per API key
  • OpenAPI spec available via drf-spectacular when ENABLE_DRF_SPECTACULAR=1

Built with VitePress ยท Source: makeplane/plane@v0.25.3
Documentation generated and authored with Qwen Code