Skip to content
Roadmaps

List roadmap items

Understanding how to use FeatureOS API to build custom integrations.

Introduction

This API allows you to retrieve a list of all items within a specific roadmap.

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

Headers

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

Path Parameters

Parameter Required Type Description
id true Integer The unique identifier of the roadmap.

Sample Response

Response Fields

Field Type Description
resource_id Integer The resource identifier for the roadmap item.
id Integer Unique identifier for the roadmap item.
slug String URL-friendly version of the roadmap item title.
title String The title of the roadmap item.
post_key String The post key identifier.
short_description String Short description of the roadmap item.
description String HTML formatted description of the roadmap item.
text_description String Plain text description of the roadmap item.
description_html String HTML formatted description of the roadmap item.
source String Source of the roadmap item (null if not specified).
post_created_at String ISO timestamp when the original post was created.
bucket Object Information about the bucket/category this item belongs to.
status Object Current status information of the roadmap item.
custom_status Object Custom status configuration for the roadmap item.
votes_count_number Integer Number of upvotes for this item.
votes_count String String representation of the vote count.
downvotes_count_number Integer Number of downvotes for this item.
downvotes_count String String representation of the downvote count.
downvoted Boolean Whether the current user has downvoted this item.
upvoted Boolean Whether the current user has upvoted this item.
assignee Object Information about the user assigned to this item (null if not assigned).
etc_scheduled Boolean Whether an estimated time to completion is scheduled.
etc_date String Estimated time to completion date (null if not set).
submitter Object Information about the user who submitted this item.
score Object Scoring information for the roadmap item.
user Object Information about the user who created this roadmap item.

Bucket Object Fields

Field Type Description
id Integer Unique identifier for the bucket.
name String Name of the bucket.
slug String URL-friendly version of the bucket name.

Status Object Fields

Field Type Description
title String Display title of the status.
value String Status value identifier.

Custom Status Object Fields

Field Type Description
title String Display title of the custom status.
value String Custom status value identifier.
color String Hex color code for the status.
status String Status identifier.
percentage Number Completion percentage for this status.
icon String Icon identifier for the status (null if not set).

Score Object Fields

Field Type Description
aggregate Number Aggregate score value.
score_type String Type of scoring system used (e.g., "rice").
reach Number Reach score component.
impact Number Impact score component.
confidence Number Confidence score component.
effort_rice Number Effort score component for RICE scoring.