Get items list

The Get items list method allows you to fetch a collection from your Cloud Firestore.

To create a request to get a collection, follow the steps below:

1. Open the request panel and click on the + button to add a new request.

2. Provide an appropriate name for the request and select the Firebase app to be used for the request. Then, choose Get items list as the method.

3. Fill in the full path to the collection in your Cloud Firestore database under the Path field.

   The Limit items field is optional, but for much larger collections, we do advise using it.

   The Subscribe realtime checkbox allows you to listen to your data and receive real-time updates.

4. (Optional) If you want to filter, you can provide a field path to filter by, as well as the criteria to filter by. In the screenshot below, we are filtering by the name field path, and we only want those matching the value John Doe to be returned.

5. (Optional) If you want to sort, you can provide a field path to sort by, as well as the direction to sort by. In the screenshot below, we are sorting by the name field path in ascending order.

6. (Optional) To paginate your results, you can use one of the following methods:

   a. Start After

   Use this method to begin pagination after a specific value.

   b. Start At

   Use this method to begin pagination at a specific value.

   c. Multiple Fields Pagination

   To paginate with multiple fields, specify sort by for the fields you want, and define the starting point as a list.