Roadmap

Manage your public roadmap items programmatically.

Endpoints

GET/roadmap

List all roadmap items

POST/roadmap

Create a roadmap item

GET/roadmap/:id

Get a single roadmap item

PATCH/roadmap/:id

Update a roadmap item

DELETE/roadmap/:id

Delete a roadmap item

List Roadmap Items

GET/roadmap

Returns a paginated list of roadmap items.

Query Parameters

Parameter	Type	Description
`status`	string	Filter by status: planned, in_progress, complete
`priority`	string	Filter by priority: low, medium, high, urgent
`sort`	string	Sort by: created_at, priority, updated_at. Prefix with - for descending.
`limit`	integer	Number of results per page (default 25, max 100)
`offset`	integer	Number of results to skip (default 0)

Example request

curl "https://planetroadmap.com/api/v1/your-org/roadmap?status=in_progress&sort=-priority" \
  -H "Authorization: Bearer pk_live_your_api_key"

Example response

{
  "data": [
    {
      "id": "rm_xyz789",
      "title": "SSO integration",
      "description": "Add SAML and OIDC single sign-on support.",
      "status": "in_progress",
      "priority": "high",
      "public": true,
      "created_at": "2026-02-01T09:00:00Z",
      "updated_at": "2026-03-10T15:30:00Z"
    }
  ],
  "total": 1,
  "limit": 25,
  "offset": 0
}

Create a Roadmap Item

POST/roadmap

Creates a new roadmap item.

Request Body

Field	Type	Required	Description
`title`	string	Yes	Title of the roadmap item
`description`	string	No	Detailed description
`status`	string	No	planned (default), in_progress, complete
`priority`	string	No	low, medium (default), high, urgent
`public`	boolean	No	Whether to show on public roadmap (default true)

Example request

curl -X POST https://planetroadmap.com/api/v1/your-org/roadmap \
  -H "Authorization: Bearer pk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "SSO integration",
    "description": "Add SAML and OIDC single sign-on support.",
    "priority": "high",
    "public": true
  }'

Example response

{
  "id": "rm_xyz789",
  "title": "SSO integration",
  "description": "Add SAML and OIDC single sign-on support.",
  "status": "planned",
  "priority": "high",
  "public": true,
  "created_at": "2026-02-01T09:00:00Z",
  "updated_at": "2026-02-01T09:00:00Z"
}

Get a Roadmap Item

GET/roadmap/:id

Retrieve a single roadmap item by ID.

Example request

curl https://planetroadmap.com/api/v1/your-org/roadmap/rm_xyz789 \
  -H "Authorization: Bearer pk_live_your_api_key"

Example response

{
  "id": "rm_xyz789",
  "title": "SSO integration",
  "description": "Add SAML and OIDC single sign-on support.",
  "status": "in_progress",
  "priority": "high",
  "public": true,
  "created_at": "2026-02-01T09:00:00Z",
  "updated_at": "2026-03-10T15:30:00Z"
}

Update a Roadmap Item

PATCH/roadmap/:id

Update a roadmap item's fields.

Example request

curl -X PATCH https://planetroadmap.com/api/v1/your-org/roadmap/rm_xyz789 \
  -H "Authorization: Bearer pk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "complete"
  }'

Example response

{
  "id": "rm_xyz789",
  "title": "SSO integration",
  "description": "Add SAML and OIDC single sign-on support.",
  "status": "complete",
  "priority": "high",
  "public": true,
  "created_at": "2026-02-01T09:00:00Z",
  "updated_at": "2026-03-21T14:00:00Z"
}

Delete a Roadmap Item

DELETE/roadmap/:id

Permanently delete a roadmap item.

Example request

curl -X DELETE https://planetroadmap.com/api/v1/your-org/roadmap/rm_xyz789 \
  -H "Authorization: Bearer pk_live_your_api_key"

Example response

{
  "id": "rm_xyz789",
  "deleted": true
}