Filter a collection with query fields.
Section: Path vs query parameters
Use query parameters for filtering
http
http
GET /users?role=admin&status=activeExplanation
Query parameters are a better fit for filtering, sorting, searching, pagination, and sparse fieldsets.
Learn the surrounding workflow
Compare similar commands or jump into common fixes when this command is part of a bigger troubleshooting path.
Related commands
Same sheet · prioritizing Path vs query parameters
Put resource identity in the path
Use the path for the primary resource being addressed.
Use includes for related resources
Let clients opt into embedded relationships.
Use consistent casing in paths
Pick one URL style and use it consistently.
Avoid format suffixes in paths
Negotiate format via headers, not path suffixes.