API endpoints

Every endpoint of the Pathwayful REST API, with headers, request and response bodies and examples in six languages. New here? Start with the introduction: base URL, authentication and errors.

Authentication

• POST Login /auth/login
• GET Get Profile /auth/profile

Roadmaps

• GET List Roadmaps /roadmaps
• GET Get Roadmap /roadmaps/:id
• POST Create Roadmap /roadmaps
• PATCH Update Roadmap /roadmaps/:id
• DELETE Delete Roadmap /roadmaps/:id

Issues

• POST Create Issue /roadmaps/:roadmap_id/issues
• PATCH Update Issue /roadmaps/:roadmap_id/issues/:id
• DELETE Delete Issue /roadmaps/:roadmap_id/issues/:id

Notifications

• GET List Notifications /notifications
• PATCH Mark as Read /notifications/:id
• DELETE Delete Notification /notifications/:id

Public Endpoints

• GET Get Public Roadmap /roadmaps/:slug
• POST Vote on Issue /roadmaps/:slug/issues/:issue_id/votes
• POST Submit Comment /roadmaps/:slug/issues/:issue_id/comments
• POST Submit Feedback /roadmaps/:slug/feedback