Skip to navigation
aVenture APICompaniesEntity Relationships

List Entity Relationship Types

View as Markdown

Returns every EntityRelationshipType value with its accepted alternate spellings and the flags that say how each type may be written and combined. Use joinable=true values with entities relationships create; acquisitionManaged=true values route through entity acquisitions; exclusiveRelationshipType lists relationship types that cannot coexist for the same unordered entity pair; readOnly=true values are emitted by reads only.

Authentication

AuthorizationBearer

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

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
acquisitionManagedboolean
Whether this type must be written through acquisition endpoints.
aliaslist of strings
Other spellings accepted for this relationship type.
canonicalstring
Canonical relationship type token used in reads and writes.
descriptionstring

Human-readable catalog meaning and placement guidance.

directionenum
How to interpret sourceEntityId and targetEntityId. DIRECTIONAL means sourceRole and targetRole are authoritative.
Allowed values:
exclusiveRelationshipTypelist of strings
Relationship types that cannot coexist for one unordered pair.
joinableboolean

Whether generic relationship join/write endpoints accept this type.

pairRulestring

Which entity types may be on each side of this relationship; writes that break it are rejected.

readOnlyboolean
Whether this type is emitted by reads only and rejected on writes.
sourceRolestring or nullOptional

Role of sourceEntityId for directional/type-oriented rows. For affinity this is member.

targetRolestring or nullOptional

Role of targetEntityId for directional/type-oriented rows. For affinity this is provider.

Errors

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