aVenture APIEntity Maintenance

List writable entity typeRecords with accepted alias tokens

View as Markdown
Returns typeRecord alias guidance for API help and CLI command suggestions.

Authentication

X-Client-Secretstring

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

Response

OK
aliaslist of strings

Alias tokens accepted by EntityType.fromRaw (case-insensitive).

canOwnPublicProductServiceRouteboolean

Whether this EntityType can provide the parent route for a public Product/Service.

canonicalstring

Canonical EntityType value (e.g. “Company”, “Investment Firm”).

descriptionstring

Human-facing meaning of this EntityType.

productServiceRouteSegmentstring
Nested public route segment shared by Product and Service records.
publicPathPrefixstring
Public website path prefix for this EntityType.

Errors

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