List records
list_recordsList records of a data model by id or slug with filtering, sorting, and pagination. Find records by field value, link to live storefront URLs, and page through results.
Instructions
List the records (entries) of a data model, by the model's id or slug. Supports filtering (per key: scalar equality, $in, $gte/$lte, $regex as a literal substring match), sort, and pagination. Each record includes its full data, so you can find a record by a field value (e.g. sku) without extra lookups. Paginated: while hasMore is true, pass nextCursor back as cursor while it is set; if hasMore is true but nextCursor is null, page with the offset instead, and past offset 10000 narrow the filter. Each record carries url: its live storefront link, built by the server from the model's urlPattern and the site's public site URL. Use it whenever you link to a record and never build a storefront URL yourself (not from a slug, not from the site address). When url is null or missing, say why instead of guessing: the model has no urlPattern (set it with update_model), the model is not delivered (deliveryAccess none, or it is the login model), the site has no public site URL, or the record - or one it links to - is unpublished.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"modelIdOrSlug": "<modelIdOrSlug>"
},
"name": "list_records"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | '<fieldKey>_asc' or '<fieldKey>_desc', e.g. createdAt_desc, price_asc. Built-in keys: createdAt, updatedAt, status; any other key must be a field of the model. Omitted: the model's default sort, else newest first. | |
| limit | No | ||
| cursor | No | nextCursor from the previous page. The page continues after it in the same filter and sort; leave the skip/offset at 0 when you pass it | |
| filter | No | Filter on record data fields (or "status"). Supported per key: scalar equality {sku: "ABC-1"}, {"$in": [...]}, {"$gte"/"$lte": ...} ranges, {"$regex": "term", "$options": "i"} - a literal substring match ("i" for case-insensitive), not a regular expression: |, \, [], .*, ^ and $ are rejected, so search one term per call. Anything else is rejected. | |
| locale | No | Language for translatable fields, e.g. 'pl'. Their values come back as plain strings in that language, and a filter on one matches that language. Defaults to the workspace's default language. | |
| offset | No | How many rows to skip, at most 10000; page past that with cursor | |
| populate | No | Relation field keys to populate | |
| modelIdOrSlug | Yes | The model's id or slug (from list_models) |