PlanningForge Documentation
Sign In Start Planning

API Reference

Integrate PlanningForge with your tools and workflows using our REST API.

API Coming Soon

Our REST API is currently in development. Contact our team to express interest and get early access information.

Planned API Features

Authentication

  • API Keys: Organization-scoped API authentication
  • OAuth 2.0: Secure authentication for third-party integrations
  • Rate Limiting: Protect against abuse with configurable limits
  • Scoped Permissions: Fine-grained access control for API operations

Screenshot: API Key Management Dashboard

Core Resources

Organizations

GET /api/v1/organizations
GET /api/v1/organizations/{id}
PUT /api/v1/organizations/{id}

Teams

GET /api/v1/teams
POST /api/v1/teams
DELETE /api/v1/teams/{id}

Planning Sessions

GET /api/v1/sessions
POST /api/v1/sessions
POST /api/v1/sessions/{id}/start

Stories & Estimates

GET /api/v1/sessions/{id}/stories
POST /api/v1/sessions/{id}/stories
PUT /api/v1/stories/{id}/estimate

Webhooks

Event Types

  • session.started - Planning session begins
  • session.completed - Session finishes with all estimates
  • story.estimated - Story receives final estimate
  • vote.cast - Individual vote submitted
  • consensus.reached - Team reaches consensus on story

Webhook Configuration

  • URL Validation: Automatic webhook endpoint verification
  • Signature Verification: HMAC signatures for security
  • Retry Logic: Automatic retries for failed deliveries
  • Event Filtering: Subscribe to specific event types

Screenshot: Webhook Configuration Interface

Integration Examples

CI/CD Integration

# Trigger estimation session after sprint planning
curl -X POST "https://api.planningforge.com/v1/sessions" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"team_id": 123, "name": "Sprint 24 Planning"}'

Jira Integration

# Sync estimates back to Jira
curl -X PUT "https://api.planningforge.com/v1/stories/456/jira-sync" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{"story_points": 8}'

Reporting Integration

# Get team velocity data
curl -X GET "https://api.planningforge.com/v1/teams/123/velocity" \
  -H "Authorization: Bearer $API_KEY" \
  -G -d "period=30days"

Screenshot: API Integration Examples Dashboard

Image placeholder - will be replaced with actual screenshot

API Development Roadmap

1

Phase 1 - Core API

Q1 2025

  • Authentication & Authorization
  • Organization & Team Management
  • Session CRUD Operations
  • Basic Webhooks
2

Phase 2 - Advanced Features

Q2 2025

  • Real-time Session APIs
  • Advanced Webhook Events
  • Bulk Operations
  • Data Export APIs
3

Phase 3 - Analytics & AI

Q3 2025

  • Analytics APIs
  • AI Estimation APIs
  • Historical Data APIs
  • Performance Metrics

Developer Preview Program

  • Early API Access for select customers
  • Direct Feedback Channel with our development team
  • Priority Support for integration questions
  • Influence Roadmap with feature requests

Requirements

  • Enterprise Plan subscription
  • Signed API Agreement with usage terms
  • Technical Contact for integration support
  • Use Case Description for API requirements

Interested in API Access?

Join our early access program and help shape the future of PlanningForge's API.

Contact API Team