Skip to navigation

List a Company's Relationships

View as Markdown

Returns relationship rows touching the path entity. Defaults to renderable-only rows where isCurrent=true and isPrimary=true. Set includeInactive=true to also return historic and non-primary rows; each row carries id, isCurrent, and isPrimary. Use entities relationships get to retrieve one row by id without an entity path.

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 list for valid values.

includeInactivebooleanOptionalDefaults to false

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

includeNonRenderablebooleanOptionalDefaults to falseDeprecated
Deprecated alias for includeInactive.
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. With type=productService on a company, returns each of its Product/Service rows nesting those direct competitor rows, so one call covers every product line. Only supported for type=competingProductService or type=productService; the result is capped, so cursor and includeInactive are not accepted alongside transitive=true.

pageintegerOptional>=0

Zero-based page index (0..N)

sizeintegerOptional>=1
The size of the page to be returned

Response headers

X-Next-CursorstringOptional

Opaque continuation token, present when another page exists; send it as cursor to read that page. The body’s number, first, and totalPages describe offset paging only; they do not advance while you follow cursors.

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

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

Errors

400
Bad Request Error
404
Not Found Error
406
Not Acceptable Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error