List entity relationships

View as Markdown

Returns relationship rows touching the path entity. Defaults to renderable-only rows where isCurrent=true and isPrimary=true. Set includeNonRenderable=true to surface historic and non-primary curation rows; returned rows include id, isCurrent, and isPrimary so hidden-row cause is explicit. Use entities relationships row get to retrieve one row by id without an entity path.

Authentication

X-Client-Secretstring

Client secret for read-only service-to-service access (no writes)

Path parameters

entityIdstringRequiredformat: "uuid"
Canonical entity UUID

Query parameters

typestringOptional

Optional EntityRelationshipType filter, one of: acceleratorParticipant, acquirer, affinity, calculated, competingProductService, competitor, customer, fundManagerFirm, parent, productService, serviceProvider, similarCompany, spinOffFrom, successor. Use entities relationships types for valid values.

includeNonRenderablebooleanOptionalDefaults to false

Include historic or non-primary rows. Default false returns only rows where isCurrent=true and isPrimary=true.

cursorstringOptional

Opaque URL-safe cursor token from X-Next-Cursor. Reuse the same filters and sort.

transitivebooleanOptionalDefaults to false
When true, returns direct curated competitors with each competitor's provider comparison signals (sells-to, pricing, ownership, funding, website) nested under its productService row. Competition is not transitively closed: A-B plus B-C surfaces B from A, never C. Only supported for type=competingProductService; the result is capped, so cursor and includeNonRenderable are not accepted alongside transitive=true.
pageintegerOptional>=0Defaults to 0

Zero-based page index (0..N)

sizeintegerOptional>=1Defaults to 20
The size of the page to be returned
sortlist of stringsOptional

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Response

OK
contentlist of objectsOptional
emptybooleanOptional
firstbooleanOptional
lastbooleanOptional
numberintegerOptional
numberOfElementsintegerOptional
pageableobjectOptional
sizeintegerOptional
sortobjectOptional
totalElementslongOptional
totalPagesintegerOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error