Skip to navigation

Get One Relationship by ID

View as Markdown

Returns one relationship by row id, including historic and non-primary rows. The response includes isCurrent and isPrimary so hidden-row cause is explicit.

Authentication

AuthorizationBearer

Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token

Path parameters

relationshipIdintegerRequired

Integer id of the relationship record (not an entity UUID).

Response headers

X-RateLimit-LimitintegerOptional

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

X-RateLimit-RemainingintegerOptional

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

X-RateLimit-ResetintegerOptional

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

Response

OK
entityobject

Joined entity on the other side of this relationship — read-only display projection. Writes name one endpoint in the URL path and the other in targetEntityId; the relationship type determines stored orientation.

relationshiplist of objects
Nested relationships for the joined entity
relationshipTypestring

Canonical relationship type, one of: acceleratorParticipant, acquirer, affinity, calculated, competingProductService, competitor, customer, fundManagerFirm, parent, productService, serviceProvider, similarCompany, spinOffFrom, successor. Similarity endpoint rows use the stored relationship type when one exists and calculated when the row comes from similarity alone.

asOfstring or nullOptionalformat: "^(?!0000)[0-9]{4}(?:-(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[12][0-9]|3[01])(?:T(?:[01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9](?:\.[0-9]{1,9})?)?(?:Z|[+-](?:(?:0[0-9]|1[0-7]):[0-5][0-9]|18:00)))?)?)?$"

Source-stated effective date, preserving stored precision

comparisonSignalsobject or nullOptional

Competitive comparison signals for the joined entity when it is a product/service provider — sells-to, pricing model, ownership, funding, and website. Null for every other joined entity. Lets comparison surfaces render provider columns without a second per-provider fetch.

createdAtdatetime or nullOptional
detailstring or nullOptional

Relationship-specific detail. acceleratorParticipant rows use batch=<label>, or program=<name>; batch=<label> only for a distinct sub-program. program= never repeats the accelerator name or the batch, and batch= never contains the accelerator name — the row already points to the accelerator entity.

idinteger or nullOptional
Integer id of the relationship record, not an entity UUID
isCurrentboolean or nullOptional

Whether this relationship is current. Default relationship reads return only rows where isCurrent=true and isPrimary=true.

isPrimaryboolean or nullOptional

Whether this relationship is the primary one shown. isCurrent=false or isPrimary=false hides the row from default relationship reads.

profileStatusobject or nullOptional

Derived profile status of the joined entity, as its list and detail reads report it; absent on write responses, nested rows, and identity-only reads.

publicSourceobject or nullOptional

Published page behind this relationship, read from the provenance event that wrote it; absent for internal sources.

sourceEntityIdstring or nullOptionalformat: "uuid"

Canonical source entity UUID stored on the relationship row. Compare with the requested entity id and /v1/entities/relationships/types sourceRole/targetRole to orient directional relationships such as parent.

targetEntityIdstring or nullOptionalformat: "uuid"

Canonical target entity UUID stored on the relationship row. Compare with the requested entity id and /v1/entities/relationships/types sourceRole/targetRole to orient directional relationships such as parent.

updatedAtdatetime or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden 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