Produktly docs
Roadmaps

List roadmaps

GET
/roadmaps

Authorization

BearerAuth
AuthorizationBearer <token>

Use an API key from the Produktly dashboard → Settings → API keys.

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/roadmaps"
{  "data": [    {      "id": 0,      "name": "string",      "publicName": "string",      "active": true,      "customDomain": "string",      "publicId": "string",      "sections": [        {          "id": 0,          "name": "string",          "items": [            {              "id": 0,              "name": "string",              "description": "string",              "votesCount": 0,              "updatedAt": "2019-08-24T14:15:22Z",              "tag": {                "id": 0,                "name": "string",                "backgroundColor": "string",                "textColor": "string"              }            }          ]        }      ]    }  ],  "pagination": {    "total": 0,    "limit": 0,    "offset": 0  }}

Update a product tour PATCH

Only the fields you send are changed. steps and targeting replace their stored values wholesale — fetch the tour first and send the full array back, preserving step ids. settings are merged. Live tours can be edited, but an update that would leave a live tour unpublishable (no steps or no targeting) returns 400; set active: false first to take it down.

Get roadmap with sections and items GET

Next Page