Sign in

v1

latestOpenAPI 3.1.1Productboard Proprietary2026-07-2453178243.2 KB
entities

List relationships

Retrieves all relationships associated with a specific Entities. This includes parent, child, and linked entities. Use this endpoint to understand how an entity is connected within the product hierarchy or planning structure.

The source entity is implicit (this entity).

get/entities/{id}/relationships

Path parameters

idstring uuid required

A universally unique identifier (UUID).

Example:123e4567-e89b-12d3-a456-426614174000

Entity identifier.

Query parameters

type'parent' | 'child' | 'link' | 'isBlockedBy' | 'isBlocking'

The type of the relationship to be established.

Relationships

  • parent: Hierarchical relationship indicating the entity is a child of the target
  • child: Hierarchical relationship indicating the entity contains the target
  • link: Generic bidirectional relationship without semantic meaning
  • isBlockedBy: Dependency relationship indicating the entity cannot proceed until the target is resolved
  • isBlocking: Dependency relationship indicating the entity prevents progress on the target

The type of the relationship to filter by (optional)

target[type]'product' | 'component' | 'feature' | 'subfeature' | 'initiative' | 'objective' | 'keyResult' | 'release' | 'releaseGroup' | 'company' | 'user'

Supported Entity types:

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

The exact types available may vary based on the configuration of the workspace.

The entity type of the target to filter relationships by (optional)

target[id]string uuid

A universally unique identifier (UUID).

Example:123e4567-e89b-12d3-a456-426614174000

The ID of the target entity to filter the relationships by (optional)

pageCursorstring

Cursor for pagination. Use the value from links.next to fetch the next page.

Response

A paginated list of relationships

Example response

{
  "data": [
    {
      "target": {
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ]
}