Filtering & Sorting

Add a query object to any GET action to filter, sort, or limit the documents returned from Firestore.

Query fields

Field	Type	Description
`attribute`	string	The document field to filter on.
`value`	string \| number	The value to compare against.
`operator`	string	Firestore comparison operator (see supported operators below).
`orderBy`	string	The field name to sort results by.
`order`	`"asc"` \| `"desc"`	Sort direction.
`limit`	number	Maximum number of documents to return. Requires `operator` or `order`.

Operators

operator accepts any valid Firestore query operator string: ==, !=, <, <=, >, >=, array-contains, in, not-in

The operator string must be a valid Firestore query operator. Passing an unrecognized value will cause the Firestore query to fail at runtime.

Using limit without also setting operator or order throws an error at startup. Always pair limit with at least one of those fields.

Examples

Filter by field
Sort results
Param + Query

Filter documents where a field matches a specific value.

request: {
  type: "GET",
  query: {
    attribute: "status",
    operator: "==",
    value: "active",
  },
}

This returns all documents where status == "active".

Filter, sort, and limit results in a single query.

request: {
  type: "GET",
  query: {
    attribute: "age",
    operator: ">",
    value: 0,
    orderBy: "age",
    order: "desc",
    limit: 10,
  },
}

This returns up to 10 documents where age > 0, sorted by age in descending order.

Combine a URL parameter with query options to filter a collection by the parameter value.

{
  collection: "orders",
  endpoint: "/api/orders/:userId",
  request: {
    type: "GET",
    paramKey: "userId",
    query: {
      operator: "==",
      orderBy: "createdAt",
      order: "desc",
      limit: 20,
    },
  },
}

Example request: GET /api/orders/user_42This returns up to 20 orders where userId == "user_42", sorted by createdAt descending. When using paramKey with query, omit attribute and value — the SDK uses the paramKey field name and URL parameter value automatically.

Get Started

Core Concepts

Guides

Reference

Query fields

Operators

Examples

Get Started

Core Concepts

Guides

Reference

​Query fields

​Operators

​Examples

Query fields

Operators

Examples