Roadmap

Get Roadmap Features

Fetch roadmap features with optional filtering, sorting, and pagination.

GET
/api/v1/roadmap

Authorization

X-API-Key<token>

Your personal API key.

In: header

Query Parameters

status?string

Filter features by status

Value in"todo" | "in-progress" | "done"
sort?string

Sort order of roadmap features

Value in"newest" | "oldest" | "recently-completed"
limit?integer

Number of items to return (max 20 enforced internally)

Default50
Range1 <= value <= 100
offset?integer

Offset for pagination

Default0
Range0 <= value

Response Body

application/json

application/json

curl -X GET "https://api.veriworkly.com/api/v1/roadmap"
{
  "success": true,
  "message": "Roadmap features fetched successfully",
  "data": {
    "items": [
      {
        "id": "feature_1",
        "title": "AI Resume Builder",
        "description": "Generate resumes using AI",
        "status": "in-progress",
        "eta": "Q3 2026",
        "tags": [
          "ai",
          "resume"
        ],
        "createdAt": "2026-04-01T00:00:00.000Z",
        "startedAt": "2026-04-10T00:00:00.000Z",
        "completedAt": null,
        "completedQuarter": null,
        "updatedAt": "2026-04-20T00:00:00.000Z",
        "timeline": "Started development"
      }
    ],
    "total": 1,
    "limit": 20,
    "offset": 0,
    "hasMore": false,
    "pagination": {
      "mode": "offset",
      "nextOffset": null,
      "nextCursor": null
    }
  }
}
{
  "success": false,
  "statusCode": 400,
  "message": "Validation failed",
  "details": [
    {
      "path": "limit",
      "message": "Number must be greater than or equal to 1"
    }
  ]
}