Skip to main content
POST
/
v1
/
public
/
topics.list
curl --location --request POST 'https://api.yourapp.com/v1/public/topics.list' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "roadmapId": "roadmap-uuid-123",
  "stageId": "stage-uuid-456",
  "sort": "createdAt",
  "direction": "DESC"
}'

{
  "data": [
    {
      "id": "topic-uuid-1",
      "urlId": "abc123",
      "url": "/add-mobile-app-abc123",
      "title": "Add mobile app",
      "description": "We need a mobile app",
      "text": "It would be great to have native mobile apps for iOS and Android.",
      "publishedAt": "2024-01-15T10:30:00Z",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-16T14:20:00Z",
      "roadmapId": "roadmap-uuid-123",
      "stageId": "stage-uuid-456",
      "subscriberId": "sub-uuid-789",
      "voteCount": 156,
      "commentCount": 23,
      "meta": {
        "ctaTitle": "Vote for this feature",
        "projectId": "project-uuid"
      }
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 50
  }
}

​
Authentication

Authorization: Bearer YOUR_API_KEY

​
Request Body

​
roadmapId
string
required
Roadmap ID (UUID)
​
stageId
string
required
Stage ID (UUID) to filter topics by
​
sort
string
default:"createdAt"
Field to sort by (createdAt, updatedAt, title)
​
direction
string
default:"DESC"
Sort direction (ASC or DESC)

​
Response

​
data
array
Array of topic objects
​
pagination
object
Pagination metadata
curl --location --request POST 'https://api.yourapp.com/v1/public/topics.list' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "roadmapId": "roadmap-uuid-123",
  "stageId": "stage-uuid-456",
  "sort": "createdAt",
  "direction": "DESC"
}'

{
  "data": [
    {
      "id": "topic-uuid-1",
      "urlId": "abc123",
      "url": "/add-mobile-app-abc123",
      "title": "Add mobile app",
      "description": "We need a mobile app",
      "text": "It would be great to have native mobile apps for iOS and Android.",
      "publishedAt": "2024-01-15T10:30:00Z",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-16T14:20:00Z",
      "roadmapId": "roadmap-uuid-123",
      "stageId": "stage-uuid-456",
      "subscriberId": "sub-uuid-789",
      "voteCount": 156,
      "commentCount": 23,
      "meta": {
        "ctaTitle": "Vote for this feature",
        "projectId": "project-uuid"
      }
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 50
  }
}

​
Behavior

  • Published Only: Only returns topics with publishedAt set (not null)
  • Stage Filtering: Topics filtered by specific roadmap stage
  • Sorted: Returns topics sorted by specified field
  • Pagination: Supports offset/limit pagination

​
Use Cases

  • Roadmap Display: Show feature requests by stage
  • Public Roadmap: Display planned features to users
  • Feature Voting: List features for users to vote on

​
Notes

  • Both roadmapId and stageId are required
  • Only published topics are returned (draft topics excluded)
  • Topics include vote and comment counts
  • Stage must belong to the specified roadmap