API Documentation
The Pathwayful API is easy to use and free for all plans.
Get Roadmap
Returns a single roadmap with its columns, issues, and tags.
GET
https://api.pathwayful.com/roadmaps/:id
Headers
-
AuthorizationREQUIRED STRINGBearer $TOKEN
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/your-roadmap-id" \
-H "Authorization: Bearer $TOKEN"
// Get a single roadmap with columns, issues, and tags
const roadmapId = 'your-roadmap-id';
const response = await fetch(`https://api.pathwayful.com/roadmaps/${roadmapId}`, {
headers: {
'Authorization': 'Bearer ' + yourToken
}
});
const roadmap = await response.json();
console.log('Roadmap:', roadmap);
# Get a single roadmap with columns, issues, and tags
import requests
roadmap_id = 'your-roadmap-id'
headers = {
'Authorization': f'Bearer {your_token}'
}
response = requests.get(
f'https://api.pathwayful.com/roadmaps/{roadmap_id}',
headers=headers
)
roadmap = response.json()
print(f"Roadmap: {roadmap}")
// Get a single roadmap with columns, issues, and tags
package main
import (
"encoding/json"
"fmt"
"net/http"
)
func main() {
roadmapID := "your-roadmap-id"
req, _ := http.NewRequest("GET", "https://api.pathwayful.com/roadmaps/"+roadmapID, nil)
req.Header.Set("Authorization", "Bearer "+yourToken)
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
var roadmap map[string]interface{}
json.NewDecoder(resp.Body).Decode(&roadmap)
fmt.Printf("Roadmap: %v\n", roadmap)
}
# Get a single roadmap with columns, issues, and tags
require 'net/http'
require 'json'
require 'uri'
roadmap_id = 'your-roadmap-id'
uri = URI("https://api.pathwayful.com/roadmaps/#{roadmap_id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Authorization'] = "Bearer #{your_token}"
response = http.request(request)
roadmap = JSON.parse(response.body)
puts "Roadmap: #{roadmap}"
<?php
// Get a single roadmap with columns, issues, and tags
$roadmapId = 'your-roadmap-id';
$ch = curl_init("https://api.pathwayful.com/roadmaps/{$roadmapId}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer ' . $yourToken
]);
$response = curl_exec($ch);
curl_close($ch);
$roadmap = json_decode($response, true);
print_r($roadmap);