Skip to navigation
aVenture APISearch and IdentifySearch

Read a Shared Directory View by Slug

View as Markdown

Resolves the slug of a public /companies/shared, /investors/shared, or /people/shared page to its stored filter, sort, and page copy.

Path parameters

slugstringRequired
Shared directory view slug.

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
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