notes
List 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.
get/notes/{id}/relationships
Path parameters
idstring uuid required
Note identifier.
Query parameters
pageCursorstring
Cursor for pagination through relationships
limitinteger
Maximum number of relationships to return per page
type'customer' | 'link'
Filter relationships by type. When provided, only relationships of the specified type are returned. If not provided, all relationship types are returned.
target[type]'user' | 'company' | 'feature' | 'subfeature' | 'product' | 'component'
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
Response
A paginated list of relationships
Example response
{
"data": [
{
"target": {
"id": "123e4567-e89b-12d3-a456-426614174000"
}
}
]
}