Skip to navigation

Get One Piece of Company Text

View as Markdown

Returns one entity-owned text row by id. Requires read auth.

Authentication

AuthorizationBearer

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

Path parameters

entityIdstringRequiredformat: "uuid"
Entity UUID owning the text row
textIdlongRequired
Text row id

Response headers

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
idinteger

Type-safe identifier for text records

ownerobject

Owning record, nested ids only: owner.entityId or owner.personId — exactly one is set, and no name fields. Writes are scoped by the owning entity/person route; owner is never a write field.

textstring
textTypestring
Value object for text type classification
complianceobject or nullOptional

Derived character/word counts and governed-contract compliance for this text row; null when not evaluated.

createdAtdatetime or nullOptional
isCurrentboolean or nullOptional

Whether this is the owner’s current text of its textType; setting it clears the flag on the owner’s other texts of that type.

isPrimaryboolean or nullOptional

Whether this is the owner’s primary text of its textType; setting it clears the flag on the owner’s other texts of that type.

languagestring or nullOptional
textNamestring or nullOptional
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