Roadmap API

Returns public roadmaps and roadmap items grouped by status.

Roadmap endpoints return 404 when the project's public roadmap is disabled.

List Roadmaps

GET v1/roadmap

Returns all public, published roadmaps for the project.

Authentication

No authentication required.

Response

{
  "roadmaps": [
    {
      "ulid": "01HXY...",
      "name": "Q1 2025",
      "title": "Q1 2025",
      "slug": "q1-2025",
      "description": "Our Q1 roadmap.",
      "created_at": "2024-01-15T10:00:00.000000Z",
      "updated_at": "2024-01-16T12:00:00.000000Z"
    }
  ],
  "allow_anonymous_upvoting": false
}

---

Show Roadmap

GET v1/roadmap/{roadmapSlug}

Returns one public, published roadmap with feedback items grouped by roadmap status.

Authentication

No authentication required.

Response

{
  "roadmaps": [
    {
      "ulid": "01HXY...",
      "name": "Q1 2025",
      "title": "Q1 2025",
      "slug": "q1-2025",
      "description": "Our Q1 roadmap.",
      "created_at": "2024-01-15T10:00:00.000000Z",
      "updated_at": "2024-01-16T12:00:00.000000Z"
    }
  ],
  "feedback_items_by_status": {
    "planned": [
      {
        "id": 123,
        "ulid": "01HXA...",
        "name": "Dark mode support",
        "description": "Please add a dark mode.",
        "votes": 42,
        "status": "planned",
        "author": { "name": "Jane", "avatar": null, "is_user": false },
        "created_at": "2024-01-15T10:00:00.000000Z",
        "image": null,
        "comments_count": 3,
        "tags": [],
        "board": {
          "name": "Feature Requests",
          "color": "#6366f1"
        }
      }
    ]
  },
  "statuses": [
    {
      "name": "Planned",
      "slug": "planned",
      "color": "#6366f1"
    }
  ],
  "allow_anonymous_upvoting": false,
  "allow_anonymous_posting": true,
  "allow_anonymous_commenting": true,
  "has_uploads_feature": true,
  "project": {
    "slug": "my-project",
    "name": "My Project",
    "logo_url": "https://cdn.example.com/logo.png",
    "brand_color": "#3b82f6",
    "brand_text_color": null
  }
}