Skip to main content

API Overview

The Pinboard API provides a comprehensive set of endpoints for managing teams, projects, tasks, and more.

Base URL​

All API endpoints are prefixed with:

/api/v1/

Available Endpoints​

CategoryEndpointsDescription
Auth4Authentication and token management
Users2User profile management
Teams21Team, members, roles, and invitations
Projects14Project management and settings
Tasks23Tasks, comments, subtasks, and notes
Time16Time entries and timesheets
Notifications3User notifications
Service Desk42Tickets, catalog, and assets
Contracts9Contract and billing management
Search2Unified search
Admin28Site administration
AI14AI chat, insights, and agents
Webhooks6Webhook management

Total: 194 endpoints

Request Format​

Headers​

All requests must include:

Authorization: Bearer <your-jwt-token>
Content-Type: application/json

Request Body​

For POST, PUT, and PATCH requests:

{
  "field": "value",
  "nestedObject": {
    "property": "value"
  }
}

Response Format​

Success Response​

{
  "id": "resource-id",
  "field": "value",
  "createdAt": "2024-01-01T00:00:00Z"
}

List Response​

{
  "items": [...],
  "total": 100,
  "page": 1,
  "limit": 20
}

Error Response​

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable message",
    "details": {}
  }
}

HTTP Status Codes​

CodeDescription
200Success
201Created
204No Content
400Bad Request
401Unauthorized
403Forbidden
404Not Found
422Validation Error
429Rate Limited
500Server Error

Rate Limiting​

  • Standard endpoints: 100 requests per minute
  • AI/Chat endpoints: 10 requests per minute

When rate limited, you'll receive:

HTTP/1.1 429 Too Many Requests
Retry-After: 60

Interactive Documentation​

Explore the API interactively:

Next Steps​