Skip to main content

Introduction

Welcome to the Pinboard API documentation. This guide will help you integrate with the Pinboard collaborative workspace platform.

What is Pinboard?​

Pinboard is a comprehensive project management and team collaboration platform that includes:

  • Team Management - Create and manage teams, roles, and permissions
  • Project Management - Organize work with projects, tasks, and sprints
  • Time Tracking - Track time entries and manage timesheets
  • Service Desk - Handle tickets, assets, and SLAs
  • AI Features - Leverage AI for insights and automation

API Overview​

The Pinboard API is a RESTful API built with FastAPI that provides:

  • JWT Authentication - Secure token-based authentication
  • Role-Based Access Control - Fine-grained permissions
  • OpenAPI Documentation - Interactive Swagger UI
  • Versioned Endpoints - All endpoints prefixed with /api/v1/

Getting Started​

  1. Quick Start - Get up and running in minutes
  2. Installation - Set up your development environment
  3. API Reference - Complete endpoint documentation

Base URL​

All API requests should be made to:

https://api.pinboard.ai/api/v1/

For local development:

http://localhost:8000/api/v1/

Need Help?​