filter parameter

A query parameter that narrows a collection to members matching an exact value, such as ?state=open.

In more detail

A filter does not change what the collection is, so a request that matches nothing is still a 200 page with an empty items list. Document the allowed fields and values, reject unknown ones with a clear problem, and keep every filter in the next link.

Example

GET /tasks?state=open&owner=alice

Related terms

Taught in

References