List rows with the Superhuman Docs API

Lists the rows of a table or view, oldest first unless sortBy says otherwise, with id, name and the values keyed by column id. The data can lag a few seconds behind the doc; send nextPageToken as pageToken for the next page.

Identifier
coda_list_rows

The request

POST https://connect.reportei.com/api/tools/coda_list_rows/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "docId": "<docId>",
    "tableIdOrName": "<tableIdOrName>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
docIdstringYesId of the doc, from List docs.
tableIdOrNamestringYesId of the table or view, from List tables. A name also works, but names change.
querystringNoFilter on one column: the column id from List columns, or its name in double quotes, then a colon and a JSON value, such as "Status":"Done" or c-tuVwxYz:42. Text values go in double quotes.
sortBystringNocreatedAt, the default, brings the oldest first; updatedAt orders by the last edit; natural follows the order shown in the table and returns only visible rows.Values: createdAt, natural, updatedAt
useColumnNamesbooleanNotrue keys the values by column name instead of id.
valueFormatstringNosimple, the default, returns plain values, with lists as comma-separated text; simpleWithArrays returns lists as arrays; rich adds Markdown to text and structure to currency, lookup, image, person and link values.Values: simple, simpleWithArrays, rich
visibleOnlybooleanNotrue returns only the visible rows and columns.
limitintegerNoRows per page. The default is 25.
pageTokenstringNoThe nextPageToken of the previous response.

Supported connections

Your customer connects their Superhuman Docs account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/coda_list_rows. It becomes your agent's tool definition with no conversion.

Other Superhuman Docs tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.