Get relationship row 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

X-Client-Secretstring

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

Path parameters

relationshipIdintegerRequired

Integer entity_relationship.id row id from EntityRelationship.id, not an entity UUID.

Response

OK
entityobject

Joined entity on the other side of this relationship — read-only display projection. Writes identify both sides only via the flat sourceEntityId and targetEntityId UUIDs, never a nested entity object.

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 stored relationship types when a curation row exists and calculated when the row comes from semantic/vector similarity.

asOfdate or nullOptional
Effective date for this relationship when known
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 entity_relationship.id row id, not an entity UUID

isCurrentboolean or nullOptional

Current-state curation flag for this relationship row. Default relationship reads return only rows where isCurrent=true and isPrimary=true.

isPrimaryboolean or nullOptional

Primary/renderable curation flag for this relationship row. isCurrent=false or isPrimary=false hides the row from default relationship reads.

sourcestring or nullOptional
Source URL or compact source label copied to the relationship row
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
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error