Skip to content

Commit 05ae957

Browse files
authored
docs: add pagination and limit: 0 information in pagination for API docs (#12243)
Fixes #12140
1 parent 800c424 commit 05ae957

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/queries/pagination.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,11 @@ All collection `find` queries are paginated automatically. Responses are returne
5555

5656
All Payload APIs support the pagination controls below. With them, you can create paginated lists of documents within your application:
5757

58-
| Control | Description |
59-
| ------- | --------------------------------------- |
60-
| `limit` | Limits the number of documents returned |
61-
| `page` | Get a specific page number |
58+
| Control | Default | Description |
59+
| ------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
60+
| `limit` | `10` | Limits the number of documents returned per page - set to `0` to show all documents, we automatically disabled pagination for you when `limit` is `0` for optimisation |
61+
| `pagination` | `true` | Set to `false` to disable pagination and return all documents |
62+
| `page` | `1` | Get a specific page number |
6263

6364
### Disabling pagination within Local API
6465

0 commit comments

Comments
 (0)