aVenture APIEntity Filters

Look up filter values inside the current search

View as Markdown

Live search within the full eligible filter universe using current entity 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

User bearer token: Clerk session JWT, Clerk OAuth access token, or Clerk API key

Request

This endpoint expects an object.
filterKeystringRequired>=1 character
Filter key
limitintegerRequired
Maximum number of search results
querystringRequired>=1 character
Query
scopeFilterobjectRequired
Entity filter scope applied to the option search

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