• AI reference · Always listed
records_list
List records. List a module's records, read only: filter by fields, sort, page.
Where it is
Always listed: call it by its name.
Does it need a yes?
Reads only: it changes nothing. Here: module records.
Inputs
| Input | Type | Needed | About |
|---|---|---|---|
module | string | yes | The module's id, e.g. class-booking (lower case, digits, dashes). · format `^[a-z0-9][a-z0-9-]{0,39}$` |
where | object | no | Top-level fields equal to these values, at most 5. For example { "day": "2026-11-03" }. |
response_format | "concise" | "detailed" | no | concise (the default): the usual fields and ids. detailed: everything. |
sort | string | no | key (the default), updated_at, created_at or a field. · format `^[A-Za-z_][A-Za-z0-9_]{0,39}$` |
order | "asc" | "desc" | no | |
limit | integer | no | How many (20 if left out, at most 100). · 1 to 100 |
offset | integer | no | Where to go on (the next_offset you got). · 0 or more |
run_id | string | no | The run_id from start. Pass it on every call: it keeps your task held. · 1 to 100 characters |
Example
{
"name": "records_list",
"arguments": {
"module": "class-booking"
}
}When it is refused
invalid: The input isn't right. The sentence names the field and the fix; nothing was done. Fix it and call again.not_found: No such thing in this company (a task, file, person, record). Check the number or name, or list first.not_allowed: Not without another step: the owner's yes, your own task held with pick_up, or a setting the owner turns on. The sentence says which.taken: Someone else holds it (another AI on that task). Pick another task.stale: It changed since you read it. Read it again and use the new version.failed: On our side or a service's, never your input. Try again in a minute; if it keeps failing, call report_problem.