/v1/definitions/{key}/rowsList or search a page's records
The rows of one record page, each as its cells plus its position and source. How to list leads, deals or contacts — and a board you made, by its board-<hex> key (its definitionKey): one door for both. Answers the LIVE board; pass ?archived=true for the archived records instead, most recently archived first. A row carries archived_at only while it is archived. The four MONEY boards — payments, payment-schedules, cash-flows, obligations — are read here too and are the ledger itself: their rows carry source ledger, the Deal column is a relation cell naming the deal record, and they take ?view= (one of that board's own view keys) and ?dealRowId= (one deal's rows, which is what the deal's Servicing tab shows). On any other page ?view= names one of its TABS — a band of its status (the deals page's Underwriting, a board's banded status option) — or one status, by name, and answers the rows in it; a word that is neither is refused naming the tabs. On any other page that links to Deals — Submissions, Offers, Contacts, a board with a Deal column — ?dealRowId=<deal row id> is the filter on that one link column: that deal's records, so "any offers yet on Vireo" is offers/rows?dealRowId=<Vireo's id>. A page with no column linking to Deals, or more than one, is refused naming them and the deal's own reads (deals/rows/<id>/detail, …/offers, …/links). A saved view is sent as what it holds: ?filter[<column label or id>]=, ?sort= and ?q=, read from the page's definition. ?limit= and ?offset= page any board, and page in the answer says how many rows the narrowing holds. ?rowId=<id> repeated reads exactly those records (up to 100), each as the one-record read answers it, in the order sent — a record's related submissions, offers or contacts are ONE read, never one call per id; it takes labels, fields and expand (detail, or context on any page) and refuses the page's narrowing. A paged read of an ordinary board also takes ?q= (case-blind substring over every cell), ?filter[<column label or id>]=<value> repeated (exact match on the stored cell; an empty value matches a blank cell; ~<text> keeps the cells that CONTAIN the text, any case — ?filter[Location]=~phoenix — reading a select by its option labels, a person by name or email, tags one tag at a time, a link by its record's name and an address part by part, and refused on a number, date or checkbox column; a value that truly opens with ~ is sent as \~), ?sort=<column label or id>&dir=asc|desc (numbers as numbers, dates as ISO text, else as text; empties last) and ?group=<groupId> (record-group membership); a computed column (formula, lookup, breakdown, files, documents) filters and sorts like any other, read over at most 5,000 rows the other filters leave (more is refused, 413, naming how to narrow); a documents column (a record's document checklist, e.g. Deals' Documents) takes missing, requested or complete — ?filter[Documents]=complete is everyone not missing docs. Any of the four without limit answers the first 50 rows (page.total says how many match). ?filter[$messages]=replied|sent narrows by who had the last word (get_definitions_key_replies says what each means), and a bound beside it by when that last word was written, in $created's shapes: ?filter[$messages]=sent&filter[$messages]=<2026-10-15 is every record whose last word is ours, written before the 15th and still unanswered — the date is today's minus N, never "4d". ?filter[$created]=>=2026-10-01 (or $updated) narrows by when the row was made (last changed) — a day, a month or an instant after >=, >, <= or <, repeated for a range, in UTC — and ?sort=$created orders by it. ?expand=context adds context keyed by row id — each record's open tasks, files, document requests, latest comms and timeline, and its links both ways (a deal's relations and lifecycle too), on ANY page, for up to 25 rows; reading rows by rowId, it is the door's default. On the deals board, ?expand=detail adds details keyed by row id — each deal's full record (lifecycle, owed amounts, files, document requests, tasks, activity) for up to 25 rows — so reviewing a page of deals is ONE read, never one detail call per deal. ?filter[$bank]=linked|error|none narrows by the record's Plaid bank links — linked connected, error the merchant must sign in to their bank again, none no bank — so "which deals have a bank connected" is ONE read, never one plaid-items call per deal. ?fields= names the only columns each row answers — column ids or labels, repeated or comma-separated (fields=Name,Status) — so reading many rows to export, count or summarise them carries the columns that matter instead of every cell; a field the page has no column for is refused. labels=true (a tool call's default; labels=false for ids) keys cells by column name and decodes relation/file cells. A DATE or datetime column takes the same bounds: ?filter[<its column id>]=>=2026-09-20 keeps the rows whose date is on or after the 20th (repeat for a range; a bare value is still the exact stored text) — so "deals funded in the last 30 days, and for how much" is ONE aggregates read over the Funded Date column, never the accounting ledger. A deal's OFFERS are read with get_definitions_key_rows_rowId_offers on the deal, not this page: it also answers the lender offers recorded on the deal's submissions (submissionOffers), which the Offers page does not hold.
Access class: def:read.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
"context" · "detail"
one entry per column: {"": ""}, or a list to match any of several — sent as filter[]= in the query string. The key is a column's label (any case) or its id — a label two columns share is refused, send the id; the value may be a select's option label, a person's name or email, or the stored value, in any case; a value opening with ~ keeps the cells CONTAINING the text after it, any case ("~phoenix"; a literal leading ~ is sent as ~). The reserved key $messages takes replied (their email or text is the newest on the record, unanswered) or sent (ours is, no answer yet), and a date bound on when that last word was written beside it: ["sent", "<2026-10-15"] is no answer since before the 15th
Responses
the action's answer
{
"data": [
{
"archived_at": "2026-01-01T00:00:00Z",
"assignees": {
"owner": [
"string"
]
},
"cells": {},
"createdBy": "string",
"display": {},
"externalId": "",
"groupId": "",
"id": "",
"next_statuses": [
"string"
],
"position": 1.5,
"source": "string"
}
],
"page": {
"limit": 1.5,
"offset": 1.5,
"total": 1.5
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}