List all roadmaps

Understanding how to use FeatureOS API to build custom integrations.

Introduction

This API allows you to retrieve a list of all your roadmaps with optional filtering by status and archived state.

POST https://api.featureos.app/api/v3/roadmaps

curl -X POST 'https://api.featureos.app/api/v3/roadmaps' \
  -H 'API-KEY: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const response = await fetch('https://api.featureos.app/api/v3/roadmaps', {
  method: 'POST',
  headers: {
    'API-KEY': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

import requests

response = requests.post(
    'https://api.featureos.app/api/v3/roadmaps',
    headers={
        'API-KEY': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    }
)
data = response.json()

Headers

Parameter	Default	Description
API-KEY	-	Generate from organization settings on the admin dashboard.

Request Body

Parameter	Required	Type	Description
status	false	String	Filter roadmaps by status. Available values: `backlog`, `planned`, `in_progress`, `paused`, `completed`, `cancelled`.
archived	false	Boolean	Filter roadmaps by archived state. Default: `false`.

Sample Request

{
    "status": "backlog",
    "archived": false
}

Sample Response

[
    {
        "id": 179,
        "title": "New Roadmap",
        "slug": "new-roadmap",
        "description": "New Roadmap",
        "is_public": false,
        "status": "backlog",
        "icon": {},
        "mode": "manual",
        "score_type": "rice",
        "score": null,
        "archived": false,
        "percentage": 0.0,
        "created_at": "2024-03-13T06:23:08.131Z",
        "kanban_view_group": "state",
        "start_date": "2024-03-13T06:23:00.000Z",
        "end_date": null,
        "user": {
            "id": 2,
            "name": "Admin",
            "profile_picture": {
                "url": null
            },
            "confirmed": true,
            "is_admin_of_organization": true,
            "is_member_of_organization": true,
            "is_csm_of_organization": true,
            "is_interactor": true,
            "user_labels": [],
            "email": "Masked Email"
        }
    }
]