Skip to main content

Query string parameters

Query string parameters modify how a request behaves without changing which resource family you are addressing.

Typical uses​

Depending on the endpoint, query parameters may be used for:

  • filtering
  • pagination
  • sorting
  • narrowing a list response
  • toggling optional response behavior

Always confirm the exact supported parameters in the API Reference.

Example shape​

GET /browsers?status=active&page=2

In that example:

  • /browsers is still the collection path
  • status and page are query parameters
  • construct query strings with your HTTP client's parameter helpers
  • omit parameters that are unset rather than sending empty strings by default
  • document which parameters your application relies on most heavily
  • keep filtering logic close to the code that owns the business use case

Common mistakes​

  • manually concatenating query strings in many places
  • assuming every endpoint supports the same parameters
  • placing required resource identifiers in the query string
  • retrying permanently invalid parameter combinations