The objects the Productboard API is built around, plus a glossary of the key terms and concepts used throughout the API documentation.
The Productboard API is organized around a small set of objects that mirror the concepts you already work with in the Productboard UI. The first half of this page lists those objects and links to each dedicated reference page. The rest defines the supporting terminology — field types, relationship types, operations, and configuration concepts — used throughout the API documentation.
If you are looking for endpoints, see the API sections in the left sidebar (Notes, Entities, Members, Teams, and so on). The pages here describe the objects those endpoints operate on.
API Concepts
API Token
Bearer token used for authentication with the Productboard API. Required for all API requests.
See our detailed guide on authentication
Configuration-Driven API
An API approach where available fields, types, and capabilities are determined by workspace configuration rather than being hardcoded. Use the /configuration endpoints to discover available options.
Learn more in the Using Configuration Endpoints guide
Cursor-Based Pagination
A pagination method using opaque cursors (pageCursor) to navigate through large result sets efficiently.
Entity Reference
A standardized object containing id, type, and links properties used to reference other entities in the system.
Field Discovery
The process of using configuration endpoints to determine what fields are available for each entity type and their capabilities.
JSON Patch Operations
Granular update operations that allow adding, removing, or modifying specific parts of an entity without replacing the entire object.
Core Objects
Each object below has its own reference page — follow the link in the heading for the full description, when to use it, and which fields to expect. The objects fall into five groups: product hierarchy, strategy and outcomes, releases, customer feedback, and people and accounts.
A note on fields: most objects have a mix of standard fields (the same for every workspace) and custom fields (configured per workspace). Use the configuration endpoint to discover which fields are available for a given object type before reading or writing.
Product hierarchy
The backbone of every workspace. Items at one level are the parents of the next.
The top-level entity in the product hierarchy, representing the entire product or service offering.
See also:
A structural element that organizes features within a product. Components add a level of hierarchical grouping between products and features.
See also Fundamentals of Productboard - Product Hierarchy
A product capability or functionality that delivers value to users. Features are the primary unit of work prioritized on the board and are typically organized under components.
See also Fundamentals of Productboard - Product Hierarchy
A smaller, more specific piece of functionality nested under a parent feature.
See also:
Strategy and outcomes
Used to connect day-to-day work to goals.
A strategic effort or project that groups related work items together to achieve specific business objectives.
See also Initiative management in Productboard
A high-level goal that an organization wants to achieve. Objectives are supported by key results in the OKR framework.
See also Defining your product objectives
A measurable outcome that contributes to achieving an objective. Part of the OKR (Objectives and Key Results) framework.
See also Building and tracking key results
Releases
Used to plan when work ships.
A specific version or deployment of product features to customers.
See also Plan releases to decide what to deliver when
A collection of related releases that are managed together, typically sharing a schedule across a set of teams.
See also Plan releases to decide what to deliver when
Customer feedback
The raw input that fuels prioritization.
User-generated content that captures feedback, ideas, or insights. Notes can be of type simple, conversation, or opportunity.
See also:
People and accounts
Who the work and feedback is about, and who is doing it.
Customers or prospects of your product. Companies are a collection of users. Notes are linked to users or companies.
See also:
An individual customer or prospect of your product. Users can be associated with companies, and notes are linked to users or companies.
A user of Productboard who has access to the workspace. Members can be organized into teams and assigned various permissions.
See Organize members into teams
A collection of Productboard members.
See Organize members into teams
General terms
Entity
General term for Productboard objects, including products, components, features, subfeatures, initiatives, objectives, key results, releases, release groups, users, and companies.
Hierarchy Item
A generic term for objects that participate in the product hierarchy (products, components, features, and subfeatures).
See also Fundamentals of Productboard - Product Hierarchy
Field Types
Boolean Field
A true/false field value, typically represented as a checkbox in the user interface.
Date Field
Date value in ISO 8601 format without time component (e.g., "2023-10-01").
Date-Time Field
Date and time value in ISO 8601 format (e.g., "2023-10-01T12:00:00Z").
Health Field
Status indicator showing the health of work items with values like onTrack, atRisk, or offTrack. Can be set manually or calculated automatically.
See also Provide health updates for your features
Member Field
Reference to a team member, containing user information like ID and email address.
See also:
Multi-Select Field
Field that allows selection of multiple values from a predefined list of options.
Name Field
Text field specifically used for entity names, with length constraints (0-255 characters).
Number Field
Numeric field that can contain integers or floating-point numbers, including negative values.
Progress Field
Numeric field representing completion progress, typically with start, target, and current values.
See also Track your work progress
Rich Text Field
HTML-formatted text content that supports formatting like bold, italics, and links.
See also Format text in Productboard descriptions
Single Select Field
Field that allows selection of exactly one value from a predefined list of options.
Status Field
Structured field representing the current state of an entity (e.g., "In Progress", "Done").
See also Customize status values for features
Tags Field
Array of labels used to categorize and organize entities.
See also How do tags work in Productboard?
Teams Field
Array of team references, allowing association with multiple teams.
See also Organize members into teams
Text Field
Plain text field with length constraints, used for general text content.
Timeframe Field
Complex field containing start date, end date, and granularity (year, quarter, month, day) for scheduling.
See also Use the Timeframe column to plan your features against time
URL Field
Field containing valid URLs with automatic format validation.
UUID Field
Universally Unique Identifier field used for entity references.
Work Progress Field
Percentage-based progress indicator with modes: manual, status-based, or calculated.
See also Track your work progress
Note Types
Conversation Note
Note type representing a dialogue between agents and customers, similar to support ticket conversations. Contains an array of conversation parts with timestamps and author information.
Opportunity Note
Note type capturing business opportunities with structured key-value field data for amounts, dates, and descriptions.
See also Import Salesforce Opportunities to Productboard as notes
Simple Note
Basic note type containing straightforward text content for capturing feedback or ideas.
Relationship Types
Child Relationship
Hierarchical relationship where the target entity is a child of the source entity.
For example, a Feature can be a child of a Component.
Customer Relationship
Association between a Note and a customer entity (either User or Company).
See also:
- Using the Customers board to see related customer context
- How to manually add a company to Productboard
- Assign users to companies
Hierarchy Item Relationship
Connection between notes and product hierarchy items (features, components, etc.).
Link Relationship
Non-hierarchical connection between entities, used for associations that don't imply parent-child structure.
Parent Relationship
Hierarchical relationship where the target entity is a parent of the source entity.
For example, a Component can be a parent of a Feature.
Operations & Actions
Add Items Operation
Patch operation that adds one or more values to a list-type field without replacing existing values.
Archive
Action to mark entities as archived, removing them from active use while preserving data.
See also:
Clear Operation
Patch operation that removes all values from a field, setting it to null or empty.
Create Action
Permission to create new entities or field values.
Delete/Remove Items Operation
Patch operation that removes specific values from a list-type field.
Filtered Search
Querying entities with specific criteria like owner, status, archived state, or custom field values.
Read Action
Permission to retrieve and view entity data.
Set Operation
Patch operation that replaces the entire value of a field.
Update Action
Permission to modify existing entity data.
Configuration & Metadata
Cardinality
Specification of whether a relationship can have single or multiple target entities e.g., one-to-one vs. one-to-many relationships.
Field Configuration
Metadata describing available fields, their types, validation rules, and supported operations for an entity type.
Field Schema
JSON Schema definition that describes the structure and validation rules for a specific field.
Lifecycle Operations
Specification of what operations (create, update, patch) are allowed for a field during different stages.
Mandatory Relationship
Relationship that must exist for an entity to be valid (e.g., features must have a parent component).
Patch Operations
Available granular operations for a field: set, addItems, removeItems, clear.
Relationship Configuration
Metadata describing what types of relationships an entity can have, their cardinality, and whether they're required.
Status & Progress
Archived Status
Boolean indicator showing whether an entity has been archived and removed from active use.
Granularity
Time unit specification for timeframes: year, quarter, month, or day.
Health Mode
Setting that determines how health status is calculated: manual (user-set) or calculated (automatic).
See also Overwriting the automatic roll-up
Health Status
Current health state of work items: notSet, onTrack, atRisk, or offTrack.
See also Provide health updates for your features
Processed Status
Boolean indicator for notes showing whether they have been processed or reviewed.
See also Create your first insight
Work Progress Mode
Setting for how work progress is calculated: manual, status-based, or calculated.
See also Progress tracking modes
System Concepts
External ID
Identifier from external systems, used to maintain references when integrating with other tools.
Origin System
External system or source where content originated (e.g., "crm", "support").
Pagination Cursor
Opaque token used to navigate through paginated API responses.
Resource Links
Self-referencing URLs that provide direct access to entity endpoints.
Source Information
Metadata about the origin of content, including external ID, system name, and source URL.
Workspace Configuration
Organization-specific settings that determine available fields, entity types, and business rules.
This page covers the core objects and concepts from Productboard API v2. For detailed implementation information, refer to the specific endpoint documentation.