API Documentation
The Pathwayful API is easy to use and free for all plans.
Get Public Roadmap
Get a public roadmap by its slug. Returns the roadmap with all columns, issues, and tags. No authentication required.
GET
https://api.pathwayful.com/roadmaps/:slug
Headers
Response body
{
"id": "uuid",
"name": "Product Roadmap",
"slug": "product-roadmap",
"description": "Our product roadmap",
"custom_domain": null,
"domain_active": false,
"created_at": "2024-01-01T00:00:00Z",
"columns": [
{
"id": "uuid",
"name": "Planned",
"position": 0
}
],
"issues": [
{
"id": "uuid",
"title": "Dark mode",
"description": "Add dark mode support",
"position": 0,
"column_id": "uuid",
"vote_count": 5,
"comment_count": 2,
"created_at": "2024-01-01T00:00:00Z",
"tags": [
{
"id": "uuid",
"name": "Feature",
"color": "#3B82F6"
}
]
}
],
"tags": [
{
"id": "uuid",
"name": "Feature",
"color": "#3B82F6"
}
]
}
Code Examples
curl -X GET "https://api.pathwayful.com/roadmaps/product-roadmap"
// Get a public roadmap by slug (no auth required)
const slug = 'product-roadmap';
const response = await fetch(`https://api.pathwayful.com/roadmaps/${slug}`);
const roadmap = await response.json();
console.log('Public roadmap:', roadmap);
# Get a public roadmap by slug (no auth required)
import requests
slug = 'product-roadmap'
response = requests.get(
f'https://api.pathwayful.com/roadmaps/{slug}'
)
roadmap = response.json()
print(f"Public roadmap: {roadmap}")
// Get a public roadmap by slug (no auth required)
package main
import (
"encoding/json"
"fmt"
"net/http"
)
func main() {
slug := "product-roadmap"
resp, err := http.Get("https://api.pathwayful.com/roadmaps/" + slug)
if err != nil {
panic(err)
}
defer resp.Body.Close()
var roadmap map[string]interface{}
json.NewDecoder(resp.Body).Decode(&roadmap)
fmt.Printf("Public roadmap: %v\n", roadmap)
}
# Get a public roadmap by slug (no auth required)
require 'net/http'
require 'json'
require 'uri'
slug = 'product-roadmap'
uri = URI("https://api.pathwayful.com/roadmaps/#{slug}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
response = http.request(request)
roadmap = JSON.parse(response.body)
puts "Public roadmap: #{roadmap}"
<?php
// Get a public roadmap by slug (no auth required)
$slug = 'product-roadmap';
$ch = curl_init("https://api.pathwayful.com/roadmaps/{$slug}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$roadmap = json_decode($response, true);
print_r($roadmap);