Skip to navigation
aVenture APICompaniesEntity Filters

Look Up Filter Values Inside the Current Search

View as Markdown

Searches all the values an entity filter can take, limited to the entities that match your other current filters. Pass the same scopeFilter used for list/refine work; the searched filter excludes its own current values so callers can expand a facet without clearing the rest of the query.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
filterKeystringRequired>=1 character
Filter key
querystringRequired>=1 character
Query
limitintegerOptional>=1Defaults to 20

Maximum number of search results; omit for 20, or the filter’s own limit when that is smaller. A larger value returns the filter’s limit.

scopeFilterobjectOptional
Entity filter scope applied to the option search. Omit to search every eligible entity.

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
filterKeystring
Canonical filter key searched
resultlist of strings
Matching option values

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