Features Pricing API Docs Sign In Get Started

API Documentation

The Pathwayful API is easy to use and free for all plans.

List Roadmaps

Returns a list of all your roadmaps with issue and feedback counts.

GET https://api.pathwayful.com/roadmaps

Headers

  • AuthorizationREQUIRED STRING
    Bearer $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",
    "issue_count": 12,
    "pending_feedback_count": 3,
    "pending_comment_count": 1
  }
]

Code Examples

curl -X GET "https://api.pathwayful.com/roadmaps" \
  -H "Authorization: Bearer $TOKEN"
// List all roadmaps
const response = await fetch('https://api.pathwayful.com/roadmaps', {
  headers: {
    'Authorization': 'Bearer ' + yourToken
  }
});

const roadmaps = await response.json();
console.log('Roadmaps:', roadmaps);
# List all roadmaps
import requests

headers = {
    'Authorization': f'Bearer {your_token}'
}

response = requests.get(
    'https://api.pathwayful.com/roadmaps',
    headers=headers
)

roadmaps = response.json()
print(f"Roadmaps: {roadmaps}")
// List all roadmaps
package main

import (
    "encoding/json"
    "fmt"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://api.pathwayful.com/roadmaps", 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 roadmaps []map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&roadmaps)
    fmt.Printf("Roadmaps: %v\n", roadmaps)
}
# List all roadmaps
require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.pathwayful.com/roadmaps')
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)
roadmaps = JSON.parse(response.body)
puts "Roadmaps: #{roadmaps}"
<?php
// List all roadmaps
$ch = curl_init('https://api.pathwayful.com/roadmaps');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer ' . $yourToken
]);

$response = curl_exec($ch);
curl_close($ch);

$roadmaps = json_decode($response, true);
print_r($roadmaps);