Overview

Productboard REST API v2 is the next-generation API designed to be more consistent, flexible, and developer-friendly than API v1.

🚧

Beta notice

Productboard REST API 2.0 is currently in Beta. Use it for experimentation, prototyping, and early integrations. Please note that individual endpoints may still change before the public release. We’re actively looking for Feedback & Help – let us know what works and what doesn’t. For critical production systems, continue using the Productboard REST API v1.0.

What is API v2?

Productboard REST API 2.0 is the next-generation API designed to offer a cleaner, more consistent, and more scalable developer experience compared to API v1. It reflects how the Productboard data model has evolved and unlocks new possibilities for automation and integrations.

API v2 is currently in Beta and intended for:

  • Experimentation and prototyping
  • Building internal tools or early integrations
  • Evaluating the new structure and providing feedback

It also introduces a new concept: configuration endpoints that describe the shape of data in your workspace. These allow your integration to discover field definitions dynamically, making it easier to build flexible, future-proof integrations.


What APIs are offered?

Currently we offer 3 different groups of API:

  • Notes API
  • Entities API
  • Analytics API

New endpoints will be added incrementally.

Notes API

The note entity in Productboard represents customer feedback, ideas, conversations, and user insights collected across your product discovery process.

Productboard’s API v2 supports the following note types:

  • simple – standard note containing freeform feedback or internal insights
  • conversation – multi-part threaded content (e.g. a chat between a user and support agent)
  • opportunity – structured feedback linked to opportunities (currently read-only via API)

Notes can include:

  • Text content
  • Tags
  • Owners
  • Customer relationships (user or company)
  • Relationships to product hierarchy entities (e.g. features, components)

To inspect which fields are available for notes in your workspace, use the Get note configuration endpoint.

For more about how notes are used in Productboard, see:

Entities API

Productboard REST API 2.0 supports a flexible and extensible data model. The following core entity types are available through the /entities endpoints:

  • product
  • component
  • feature
  • subfeature
  • initiative
  • objective
  • keyResult
  • release
  • releaseGroup

To learn how these entities are structured in your workspace and which fields are available, start with the Get entity configuration or List entities endpoints.

For a deeper understanding of how these concepts map to the Productboard user interface, check out:

Analytics API

The Analytics API provides access to usage data that helps you understand how Productboard is being adopted and used across your workspace.

You can retrieve metrics related to:

  • Feature views
  • User activity and engagement
  • Note processing trends
  • Insights usage
  • Board views and interactions

These metrics can be used to:

  • Build internal dashboards
  • Monitor adoption across teams
  • Identify underused areas of the product
  • Measure the impact of product initiatives

Analytics data is read-only and typically used for reporting and analysis purposes. All data is scoped to your workspace and requires appropriate permissions.

To get started, see:


Configuration endpoints

Productboard workspaces can be customized with different fields, workflows, and structures — which means the data model isn't static.

To support this flexibility, API v2 introduces /configuration endpoints for each resource type. These endpoints return:

  • A list of available fields for the resource
  • Metadata about each field (type, label, options, etc.)
  • How those fields can be used when creating or updating records

Instead of relying on hardcoded assumptions, you can query the /configuration endpoint to understand the current shape of the data — tailored to each workspace.

Example:

GET /notes/configuration

This makes your integration more resilient and adaptable as Productboard evolves.


Design principles

This API is built around a few core principles:

  • Consistency – predictable naming, uniform structure, clear resource models, consistent naming
  • Flexibility – support for dynamic schemas and workspace-specific configuration
  • RESTful design – standard HTTP methods, resource-oriented URLs, JSON payloads
  • Developer experience – intuitive structure, helpful errors, easy to get started

This version builds on everything we learned from API v1, and is designed to support how Productboard is used in complex, real-world workflows.


What to expect during Beta

  • We may change or remove endpoints based on feedback
  • Response formats and field names might still evolve
  • Documentation will be updated regularly
  • There may be some gaps or missing features compared to v1
⚠️

Note: We recommend not using the Beta API in production yet.


Authentication

Authentication is required for all requests. We support:

  • API Token (PAT)
  • OAuth 2.0 Authorization Code
  • OAuth 2.0 JWT Bearer

See Authentication for details.


Rate Limits

Rate limits apply to all requests.

  • 50 requests per second per access token
  • If you exceed this, you'll receive an HTTP 429 response with a Retry-After header

See Rate Limits for more information.


Known issues and limitations

You can find up-to-date known issues and missing functionality in the Known Issues section.


Give us feedback

We’re actively looking for feedback on:

  • Endpoint structure and naming
  • Data modeling
  • Developer experience
  • Anything confusing or missing

See Feedback & Help