Skip to navigation
aVenture APISearch and IdentifySearch

Share a Directory View

View as Markdown

Publishes the exact filter and sort a /companies, /investors, or /people page shows under the supplied UUID, with a model-written heading, title, and description. The view must match at least one public record and may set only public filter fields. Reusing the UUID with the same view, or sharing a view already published, returns that publication; a different view under a used UUID is rejected. The publication is readable without authentication.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
directoryenum or nullOptional
Directory page the view filters.
Allowed values:
entityFilterobject or nullOptional
Body the companies or investors page sends to entity search.
idstring or nullOptionalformat: "uuid"
Stable sharing UUID generated once and reused across retries.
personFilterobject or nullOptional
Body the people page sends to person search.
sortstring or nullOptional0-100 characters
Sort the page sends, as property,asc or property,desc.

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
descriptionstring

Search-result description, at most 155 characters.

publicationobject
Public directory publication metadata.
titlestring

Search-result title, at most 60 characters.

entityFilterobject or nullOptional
Entity filter of a companies or investors view.
personFilterobject or nullOptional
Person filter of a people view.
sortstring or nullOptional

Sort as property,direction; absent uses the directory default.

Errors

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