aVenture APIPerson Metadata

Search people filter options

View as Markdown
Searches available people filter options.

Query parameters

filterKeystringRequired
Filter key to search within
searchstringRequired

Search keyword or phrase. Single characters valid; stop words rejected.

pageintegerOptional
Page index is fixed to 0 for filter search
sizeintegerOptional

The size of the page to be returned; filter-search default 20, maximum 100.

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
406
Not Acceptable Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error