Features Pricing API Docs Sign In Get Started

API Documentation

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

Create Issue

Create a new issue in a roadmap. Assign it to a column and optionally add tags.

POST https://api.pathwayful.com/roadmaps/:roadmap_id/issues

Headers

  • AuthorizationREQUIRED STRING
    Bearer $TOKEN
  • Content-TypeREQUIRED STRING
    application/json

Request body

{
  "issue": {
    "title": "Dark mode",
    "description": "Add dark mode support",
    "column_id": "column-uuid",
    "position": 0,
    "tag_ids": ["tag-uuid"]
  }
}

Response body

{
  "id": "uuid",
  "title": "Dark mode",
  "description": "Add dark mode support",
  "position": 0,
  "column_id": "uuid",
  "vote_count": 0,
  "comment_count": 0,
  "created_at": "2024-01-01T00:00:00Z",
  "tags": []
}

Code Examples

curl -X POST "https://api.pathwayful.com/roadmaps/your-roadmap-id/issues" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "issue": {
      "title": "Dark mode",
      "description": "Add dark mode support",
      "column_id": "column-uuid",
      "position": 0,
      "tag_ids": ["tag-uuid"]
    }
  }'
// Create a new issue in a roadmap
const roadmapId = 'your-roadmap-id';
const response = await fetch(`https://api.pathwayful.com/roadmaps/${roadmapId}/issues`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer ' + yourToken,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    issue: {
      title: 'Dark mode',
      description: 'Add dark mode support',
      column_id: 'column-uuid',
      position: 0,
      tag_ids: ['tag-uuid']
    }
  })
});

const issue = await response.json();
console.log('Created issue:', issue);
# Create a new issue in a roadmap
import requests

roadmap_id = 'your-roadmap-id'
headers = {
    'Authorization': f'Bearer {your_token}',
    'Content-Type': 'application/json'
}

data = {
    'issue': {
        'title': 'Dark mode',
        'description': 'Add dark mode support',
        'column_id': 'column-uuid',
        'position': 0,
        'tag_ids': ['tag-uuid']
    }
}

response = requests.post(
    f'https://api.pathwayful.com/roadmaps/{roadmap_id}/issues',
    headers=headers,
    json=data
)

issue = response.json()
print(f"Created issue: {issue}")
// Create a new issue in a roadmap
package main

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

func main() {
    roadmapID := "your-roadmap-id"
    data := map[string]interface{}{
        "issue": map[string]interface{}{
            "title":       "Dark mode",
            "description": "Add dark mode support",
            "column_id":   "column-uuid",
            "position":    0,
            "tag_ids":     []string{"tag-uuid"},
        },
    }
    jsonData, _ := json.Marshal(data)

    req, _ := http.NewRequest("POST", "https://api.pathwayful.com/roadmaps/"+roadmapID+"/issues", bytes.NewBuffer(jsonData))
    req.Header.Set("Authorization", "Bearer "+yourToken)
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    var issue map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&issue)
    fmt.Printf("Created issue: %v\n", issue)
}
# Create a new issue in a roadmap
require 'net/http'
require 'json'
require 'uri'

roadmap_id = 'your-roadmap-id'
uri = URI("https://api.pathwayful.com/roadmaps/#{roadmap_id}/issues")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['Authorization'] = "Bearer #{your_token}"
request['Content-Type'] = 'application/json'
request.body = {
  issue: {
    title: 'Dark mode',
    description: 'Add dark mode support',
    column_id: 'column-uuid',
    position: 0,
    tag_ids: ['tag-uuid']
  }
}.to_json

response = http.request(request)
issue = JSON.parse(response.body)
puts "Created issue: #{issue}"
<?php
// Create a new issue in a roadmap
$roadmapId = 'your-roadmap-id';
$data = [
    'issue' => [
        'title' => 'Dark mode',
        'description' => 'Add dark mode support',
        'column_id' => 'column-uuid',
        'position' => 0,
        'tag_ids' => ['tag-uuid']
    ]
];

$ch = curl_init("https://api.pathwayful.com/roadmaps/{$roadmapId}/issues");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer ' . $yourToken,
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));

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

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