Quickstart

Get up and running with the Planet Roadmap API in four steps.

1. Get an API Key

Go to Settings → API Keys in your dashboard and create a new key. Copy it somewhere safe — you will not be able to see it again.

2. List Feature Requests

Use the key to fetch your organization's feature requests.

List requests

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

3. Create a Feature Request

Submit a new feature request with a title and description.

Create a request

curl -X POST https://planetroadmap.com/api/v1/your-org/requests \
  -H "Authorization: Bearer pk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Dark mode support",
    "description": "Add a dark mode toggle to the dashboard."
  }'

4. Update Status

Move a request through your workflow by updating its status.

Update status

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

Next up: Learn more about authentication and API key permissions.