List relationships

get

https://api.productboard.com/v2/notes/{id}/relationships

Retrieves all relationships connected to a specific note.

This includes:

Customer relationship (either a User or Company entity)
Product link relationships (e.g. linked features)

Customer relationship rules

A note can have a relationship to exactly one customer entity (User or Company).
If the note has a User as the customer, and that User is associated with a Company, only the User is returned.
If the note has a User without a Company, the User is returned.
If the note has a Company, the Company is returned.
If the note has no customer relationship, an empty array is returned.

Product link relationships

Notes can be linked to multiple Product Management entities (e.g. features, components).
All such relationships are returned in the same response.

To discover supported relationship types, use the /v2/notes/configurations endpoint.

Path Params

uuid

required

Note identifier.

Query Params

pageCursor

string

Cursor for pagination through relationships

limit

integer

≥ 1

Maximum number of relationships to return per page

type

string

enum

Filter relationships by type. When provided, only relationships of the specified type are returned. If not provided, all relationship types are returned.

Allowed:

target[type]

string

enum

Filter relationships by the target entity type. When provided, only relationships where the target matches the specified entity type are returned. If not provided, all target types are returned.

Available values:

user: Customer relationships where the target is a user
company: Customer relationships where the target is a company
feature: Link relationships where the target is a feature
subfeature: Link relationships where the target is a subfeature
product: Link relationships where the target is a product
component: Link relationships where the target is a component

Allowed:

Responses

200A paginated list of relationships

400Bad Request - Invalid input format or malformed request

401Unauthorized - Missing or invalid authentication credentials

403Forbidden - Insufficient permissions

404Not Found - The requested resource does not exist or is not accessible

408Request Timeout - The server did not receive a complete request within the allowed time

429Too Many Requests - API rate limit exceeded, reduce request frequency and retry after the indicated time

500Internal Server Error - An unexpected error occurred on the server, please retry or contact support