list_records
Retrieve records from a PocketBase collection with filtering, sorting, field selection, relation expansion, and pagination controls.
Instructions
List records in a collection with filtering, sorting, and pagination.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | The page number to return. Defaults to 1. | |
| sort | No | Sort expression (e.g. '-created', '+title'). | |
| expand | No | Comma-separated list of relations to expand (e.g. 'author,tags'). | |
| fields | No | Comma-separated list of fields to return (e.g. 'id,title,created'). | |
| filter | No | PocketBase filter expression (e.g. "status = 'published'"). | |
| per_page | No | Number of records per page. Defaults to 30. | |
| collection | Yes | The collection name or ID. | |
| skip_total | No | If true, skip the total counts query for faster responses. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | ||
| items | Yes | ||
| perPage | Yes | ||
| totalItems | Yes | ||
| totalPages | Yes |