> ## Documentation Index > Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt > Use this file to discover all available pages before exploring further. # Productboard > Productboard is a product management platform that gathers feedback, prioritizes features, and aligns roadmaps based on customer insights and strategic goals Productboard is a product management platform that gathers feedback, prioritizes features, and aligns roadmaps based on customer insights and strategic goals `productboard` · **99 tools** · no triggers ## Connect it ```bash theme={"theme":"github-dark"} run auth productboard run auth productboard --scope team # shared with the organization ``` Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one. ## Use it ```bash theme={"theme":"github-dark"} run productboard # common commands run productboard --all # every command ``` ```ts theme={"theme":"github-dark"} import { productboard } from "@boxd/run"; ``` ## Common tools | Tool | What it does | | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `create-company` | Tool to create a new company in Productboard. Use when you need to add a company record after gathering its details and optional metadata. | | `create-company-field` | Tool to create a new custom field for companies. Use when you need to define custom company attributes in Productboard after confirming the field schema. | | `create-component` | Tool to create a new (sub)component under a product or component. | | `create-entities-v2` | Tool to create a new entity in Productboard using the v2 API. | | `create-feature` | Tool to create a new feature or subfeature in Productboard. Use when you need to add a feature to a product or component, or create a subfeature... | | `create-notes-v2` | Tool to create a new note in Productboard using the v2 API. Use when you need to create simple text notes or conversation-style notes with optional... | | `create-objectives` | Tool to create a new objective in Productboard. Use when you need to create a strategic objective with optional details like owner, parent, status, and timeframe. | | `create-release` | Tool to create a new release in Productboard. Use when you need to create a release with a name, description, and assigned release group. | | `create-users` | Tool to create a new user in Productboard. Use when you need to add a user with email, name, and/or external identifier. | | `create-webhook` | Tool to create a new webhook subscription. Use when you need to register a public endpoint to receive webhooks from Productboard. | | `get-component` | Tool to retrieve details of a specific component. Use when you have the component ID to fetch its full details including description, parent... | | `get-hierarchy-entities-custom-fields` | Tool to retrieve a specific custom field definition for hierarchy entities. | | `get-notes-configurations-v2` | Tool to retrieve note configuration by type (simple, conversation, or opportunity). | | `get-objective` | Tool to retrieve details of a specific objective. Use when you have the objective ID to fetch its full details including name, description, status, timeframe, and owner. | | `list-companies` | Tool to list companies. Use when you need a paginated list of companies with optional filters. | | `list-custom-fields` | Lists custom field definitions for hierarchy entities (Products, Components, Features). | | `list-custom-field-values` | Lists custom field values for hierarchy entities (products, components, features) in Productboard. | | `list-entities-v2` | Tool to list entities from Productboard using the v2 API. Use when you need a paginated list of PM entities (products, components, features... | | `list-feature-initiatives` | Tool to list initiatives linked to a given feature. Use when you need to retrieve all initiatives associated with a feature after confirming its ID. | | `list-feature-objectives` | Lists all objectives (OKRs) linked to a top-level feature. Returns objective IDs and hypermedia links. | | `list-feature-release-assignments` | Tool to list feature–release assignments. Use when you need to retrieve assignments for a specific feature or release with optional state or date... | | `list-feature-statuses` | Tool to list feature statuses. Use when you need to retrieve all feature status records in a paginated form. | | `list-feedback-form-configurations` | Tool to list feedback form configurations. Use when you need a paginated list of feedback form configurations. | | `list-initiatives` | Tool to list initiatives from Productboard. Use when you need a paginated list of initiatives with optional filters for archived status, owner, and status. | | `list-jira-integrations` | Tool to list Jira integrations. Use when you need to retrieve Productboard's connected Jira integrations with optional pagination. | | Tool | What it does | | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `add-note-followers` | Tool to add multiple followers to a Productboard note. Use when you need to bulk-add existing users as followers to a specific note by their email addresses. | | `add-note-tag` | Adds a tag to a Productboard note for categorization and organization. | | `create-company` | Tool to create a new company in Productboard. Use when you need to add a company record after gathering its details and optional metadata. | | `create-company-field` | Tool to create a new custom field for companies. Use when you need to define custom company attributes in Productboard after confirming the field schema. | | `create-component` | Tool to create a new (sub)component under a product or component. | | `create-entities-relationships-v2` | Tool to create a relationship between two entities in Productboard. | | `create-entities-v2` | Tool to create a new entity in Productboard using the v2 API. | | `create-feature` | Tool to create a new feature or subfeature in Productboard. Use when you need to add a feature to a product or component, or create a subfeature... | | `create-feature-objective-link` | Tool to create a link between a feature and an objective (OKR). | | `create-note-link` | Tool to create a link between a note and an entity. Use when associating a note with a productboard entity. | | `create-notes-v2` | Tool to create a new note in Productboard using the v2 API. Use when you need to create simple text notes or conversation-style notes with optional... | | `create-objectives` | Tool to create a new objective in Productboard. Use when you need to create a strategic objective with optional details like owner, parent, status, and timeframe. | | `create-objectives-links-features` | Tool to create a new link between an objective and a feature. | | `create-release` | Tool to create a new release in Productboard. Use when you need to create a release with a name, description, and assigned release group. | | `create-users` | Tool to create a new user in Productboard. Use when you need to add a user with email, name, and/or external identifier. | | `create-webhook` | Tool to create a new webhook subscription. Use when you need to register a public endpoint to receive webhooks from Productboard. | | `delete-company` | Tool to delete a specific company. Use when you have confirmed the company ID and need to remove it from Productboard. | | `delete-company-field` | Tool to delete a specific company custom field. Use after confirming the field ID and ensuring no dependencies remain. | | `delete-custom-field-value` | Tool to delete a custom field value from a hierarchy entity in Productboard. | | `delete-entities-relationships-v2` | Tool to delete a relationship between two entities. Use when you need to remove a specific relationship type between entities in Productboard. | | `delete-entities-v2` | Tool to delete a PM entity using the v2 API. Use when you need to permanently remove an entity from Productboard. | | `delete-feature` | Tool to delete a specific feature. Use when you have confirmed the feature ID and deleted its subfeatures before removal. | | `delete-feature-objective-link` | Tool to delete a link between a feature and an objective. Use when you need to remove the association between a specific feature and objective. | | `delete-initiatives` | Tool to delete a specific initiative. Use when you have confirmed the initiative ID and need to permanently remove it from Productboard. | | `delete-key-results` | Tool to delete a specific key result from Productboard. Use when you need to remove a key result that is no longer relevant or was created in error. | | `delete-notes-relationships-v2` | Tool to delete a note relationship. Use when you need to remove a specific relationship between a note and another entity (customer or link) in Productboard. | | `delete-notes-v2` | Tool to delete a note using the v2 API. Permanently removes the note and all its associated data. | | `delete-note-tag` | Tool to remove a tag from a Productboard note. Use when you need to detach a specific tag from a note after tagging. | | `delete-objectives` | Tool to delete a specific objective from Productboard. Use when you have confirmed the objective ID and need to permanently remove it. | | `delete-objectives-links-features` | Tool to delete a link between an objective and a feature. Use when you need to remove the association between a specific objective and feature. | | `delete-release` | Tool to delete a specific release. Use when you have confirmed the release ID and need to remove it from Productboard. | | `delete-user` | Tool to delete a specific user. Use when you have confirmed the user ID and need to remove it from Productboard. | | `delete-webhook` | Tool to delete a webhook subscription. Use when you need to remove a webhook subscription from Productboard. | | `get-component` | Tool to retrieve details of a specific component. Use when you have the component ID to fetch its full details including description, parent... | | `get-custom-field-value` | Tool to retrieve a custom field's value for a specific hierarchy entity. | | `get-entities-configurations-v2` | Tool to retrieve entity configuration for a specific type. Use when you need to understand the structure, fields, and relationships available for an... | | `get-entities-v2` | Tool to retrieve a PM entity using the v2 API. Use when you need to fetch details of a specific entity by its UUID. | | `get-feature-release-assignment` | Tool to retrieve a specific feature release assignment. Use when you need to check if a particular feature is assigned to a specific release. | | `get-hierarchy-entities-custom-fields` | Tool to retrieve a specific custom field definition for hierarchy entities. | | `get-notes-configurations-v2` | Tool to retrieve note configuration by type (simple, conversation, or opportunity). | | `get-notes-v2` | Tool to retrieve a note using the v2 API. Use when you need to fetch details of a specific note by its UUID. | | `get-objective` | Tool to retrieve details of a specific objective. Use when you have the objective ID to fetch its full details including name, description, status, timeframe, and owner. | | `get-release` | Tool to retrieve details of a specific release by ID. Use when you need complete information about a single release. | | `get-release-group` | Tool to retrieve details of a specific release group. Use when you have the release group ID to fetch its full details. | | `get-webhooks` | Tool to retrieve details of a specific webhook subscription. | | `list-analytics-member-activities-v2` | Tool to retrieve member activity analytics data from Productboard. | | `list-companies` | Tool to list companies. Use when you need a paginated list of companies with optional filters. | | `list-company-fields` | Lists all custom field definitions for companies in your Productboard workspace. | | `list-custom-fields` | Lists custom field definitions for hierarchy entities (Products, Components, Features). | | `list-custom-field-values` | Lists custom field values for hierarchy entities (products, components, features) in Productboard. | | `list-entities-configurations-v2` | Tool to retrieve configurations for all entity types in Productboard. | | `list-entities-relationships-v2` | Tool to retrieve relationships for an entity in Productboard. | | `list-entities-v2` | Tool to list entities from Productboard using the v2 API. Use when you need a paginated list of PM entities (products, components, features... | | `list-feature-initiatives` | Tool to list initiatives linked to a given feature. Use when you need to retrieve all initiatives associated with a feature after confirming its ID. | | `list-feature-objectives` | Lists all objectives (OKRs) linked to a top-level feature. Returns objective IDs and hypermedia links. | | `list-feature-release-assignments` | Tool to list feature–release assignments. Use when you need to retrieve assignments for a specific feature or release with optional state or date... | | `list-feature-statuses` | Tool to list feature statuses. Use when you need to retrieve all feature status records in a paginated form. | | `list-feedback-form-configurations` | Tool to list feedback form configurations. Use when you need a paginated list of feedback form configurations. | | `list-initiatives` | Tool to list initiatives from Productboard. Use when you need a paginated list of initiatives with optional filters for archived status, owner, and status. | | `list-jira-integrations` | Tool to list Jira integrations. Use when you need to retrieve Productboard's connected Jira integrations with optional pagination. | | `list-key-results` | List key results from Productboard. Key results are measurable outcomes that track progress toward objectives. | | `list-notes-configurations-v2` | Tool to list note configurations from Productboard v2 API. Use when you need to discover available fields, relationships, and validation rules for... | | `list-notes-links` | Tool to list links associated with a note. Returns entities (products, components, features, or subfeatures) linked to the specified note. | | `list-notes-relationships-v2` | Tool to retrieve relationships associated with a note. Returns entities (users, companies, features, components, products) linked to the specified... | | `list-notes-v2` | Tool to retrieve a paginated list of notes from Productboard using the v2 API. | | `list-note-tags` | Tool to retrieve all tags associated with a specific Productboard note. | | `list-objectives-links-features` | Lists all features linked to a specific objective. Returns feature IDs and hypermedia links for each linked feature. | | `list-objectives-links-initiatives` | Tool to list initiatives linked to a specific objective. Use when you need to retrieve all initiatives associated with an objective after confirming its ID. | | `list-plugin-integrations` | List all plugin integrations in the Productboard workspace. Plugin integrations allow you to add columns to the Productboard Features board that... | | `list-release-groups` | Lists all release groups in the Productboard workspace. Release groups allow organizing multiple sets of releases (e.g., sprints, development cycles... | | `list-releases` | Tool to list all releases in Productboard. Use when you need a paginated list of releases; follow links.next for more pages. | | `list-users` | Retrieves a paginated list of all users in the Productboard workspace. | | `list-webhooks` | Tool to list all webhook subscriptions. Use when you need to retrieve all registered webhook endpoints and their configurations. | | `remove-note-follower` | Tool to remove a follower from a Productboard note. Use after confirming the note ID and follower email are correct. | | `retrieve-company` | Tool to retrieve details of a specific company. Use when you have the company ID to fetch its full details. | | `retrieve-company-field` | Tool to retrieve details of a specific company custom field. | | `retrieve-company-field-value` | Tool to retrieve a specific company custom field value. Use when you need the current value of a custom field for a given company by its IDs. | | `retrieve-feature` | Tool to retrieve details of a specific feature. Use when you need complete info on one feature. | | `retrieve-product` | Tool to retrieve details of a specific product. Use when you have the product ID to fetch its full details. | | `retrieve-user` | Tool to retrieve details of a specific user. Use when you have the user ID to fetch its full details. | | `scim-list-users` | Tool to list users via SCIM. Use when checking for existing users before creation. | | `search-entities-v2` | Tool to search for entities across Productboard using the v2 API. | | `set-company-field-value` | Tool to set or replace a specific company custom field's value. | | `set-custom-field-value` | Tool to set a custom field value on a hierarchy entity. Use when you need to update a product, component, or feature field with a specific value... | | `set-entities-relationships-parent-v2` | Tool to set parent relationship on an entity. Use when establishing hierarchical relationships between entities in Productboard. | | `set-feature-release-assignment` | Tool to update a feature release assignment. Use when you need to assign a feature to a release (set assigned=true) or remove it from a release (set assigned=false). | | `set-features` | Tool to update a feature by ID. Use when you need to modify feature properties like name, description, status, parent, timeframe, or archived flag. | | `set-notes-relationships-customer-v2` | Tool to set a customer relationship on a note in Productboard. | | `set-product` | Tool to update a product using PUT method in Productboard. Use when you need to modify a product's name, description, or owner with full replacement semantics. | | `update-companies-custom-fields` | Tool to update a company custom field name. Use when you need to rename an existing company custom field in Productboard. | | `update-company` | Tool to update an existing company in Productboard. Use when you need to modify company details such as name, description, domain, or source metadata. | | `update-component` | Tool to update an existing component. Use when you need to modify component name, description, owner, or parent entity. | | `update-entities-v2` | Tool to update a PM entity using the v2 API. Use when you need to modify entity fields or apply patch operations to products, components, features... | | `update-features` | Tool to update a feature in Productboard. Use when modifying feature details like name, description, status, owner, parent, or timeframe. | | `update-notes-v2` | Tool to update a note using the v2 API. Supports two update methods: direct field updates via 'fields' parameter or granular patch operations via 'patch' parameter. | | `update-objectives` | Tool to update an existing objective in Productboard. Use when you need to modify objective properties such as name, description, owner, status... | | `update-product` | Tool to update a product in Productboard. Use when you need to modify a product's name, description, or owner. | | `update-release` | Tool to update an existing release in Productboard. Use when you need to modify release properties such as name, description, state, archived status... | | `update-user` | Tool to update a user's information. Use when you need to modify a user's name, email, or external ID. | [Open Productboard in the console →](https://app.boxd.sh/integrations/detail/productboard)