Skip to main content
GET
List filter pages

Authorizations

Authorization
string
header
required

A bearer token obtained through one of the two flows below.

Headers

Accept-Language
enum<string>

The language to answer in: specificationLabels, translatedDescription, facet and label names, the content pages, and every other translated word in the answer. Read on every request, whatever the endpoint. One we do not have falls back to English rather than failing.

Available options:
en,
nl,
de,
es,
fr,
it,
pt,
fi,
pl

Query Parameters

filter[q]
string

Typed text, for an autocomplete. Ranked by the same index and the same relevance threshold as the search bar on the website, so the same letters offer the same pages.

Each suggestion carries autocompleteName (the short name an editor gave it, falling back to name), watchCount, and search — so tapping one is a /v1/watches request with exactly those words and facets. blocks is null, as in any list.

Ordered by how well each page matches, so sort alongside it is refused with 400 search_only_sort; filter[slug] and filter[parent] are not applied while searching. If the index cannot be reached the answer is 503 search_unavailable, never an empty page.

Five is usually enough: page[size]=5.

filter[slug]
string

How an app arrives — it has a link, and a link carries a slug.

filter[parent]
string

Everything one level under a page, for drawing its children. Takes the parent's slug, as every other filter here does — a link carries a slug, not an id.

sort
enum<string>

name or watchCount, either with a leading -. The default is -watchCount.

Available options:
name,
-name,
watchCount,
-watchCount
page[number]
integer
default:1
Required range: x >= 1
page[size]
integer
default:25
Required range: 1 <= x <= 50

Response

A page of filter pages.

data
object[]
required
included
object[]

Present when the answer is a page.

meta
object

page when the answer is a page: from, to, perPage and hasMore for a cursor (from and to are cursors, not numbers), or currentPage, from, lastPage, perPage, to and total for numbered pages. Some lists add their own beside it, such as statusCounts, unread or facets.