Coda
  1. Rows
Coda
  • Permissions
    • Get sharing metadata
      GET
    • Delete permission
      DELETE
    • Search principals
      GET
    • Get ACL settings
      GET
    • Update ACL settings
      PATCH
    • List permissions
      GET
    • Add permission
      POST
  • Pages
    • Content export status
      GET
    • List pages
      GET
    • Create a page
      POST
    • Begin content export
      POST
    • Get a page
      GET
    • Delete a page
      DELETE
    • Update a page
      PUT
  • Tables
    • List tables
      GET
    • Get a table
      GET
  • Columns
    • List columns
      GET
    • Get a column
      GET
  • Rows
    • Push a button
      POST
    • List table rows
      GET
    • Insert/upsert rows
      POST
    • Delete multiple rows
      DELETE
    • Get a row
      GET
    • Delete row
      DELETE
    • Update row
      PUT
  • Formulas
    • List formulas
    • Get a formula
  • Controls
    • List controls
    • Get a control
  • CustomDocDomains
    • List custom doc domains
    • Add custom domain
    • Deletes a custom domain
    • Updates a custom domain
    • Gets custom doc domains providers
  • Miscellaneous
    • Resolve browser link
    • Get mutation status
  • Automations
    • Trigger automation
  • Analytics
    • List doc analytics
    • List page analytics
    • Get doc analytics summary
    • List Pack analytics
    • Get Pack analytics summary
    • Get analytics last updated day
    • List Pack formula analytics
  • Workspaces
    • List workspace users
    • List workspace roles
    • Updates user role
  • Packs
    • List Packs
    • Create Pack
    • Gets the JSON Schema for Pack configuration.
    • List the versions for a Pack.
    • Get the next valid version for a Pack.
    • Get the difference between two pack versions.
    • Register Pack version
    • Pack version upload complete
    • Create a new Pack release.
    • List the releases for a Pack.
    • Update an existing Pack release.
    • Set the OAuth configurations of the Pack.
    • Retrieve the OAuth configuration of the Pack.
    • List permissions for a Pack
    • Add a permission for Pack
    • Delete a permission for Pack
    • List makers for Pack
    • Add a maker for Pack
    • Delete a maker for Pack
    • List categories for Pack
    • Add a category for Pack
    • Delete a category for Pack
    • Upload a Pack asset.
    • Upload Pack source code.
    • Pack asset upload complete
    • Pack source code upload complete
    • get the source code for a Pack version.
    • List the Pack listings accessible to a user.
    • Get detailed listing information for a Pack.
    • List featured docs for a Pack
    • Update featured docs for a Pack
    • Get a single Pack
    • Update Pack
    • Delete Pack
    • Set the system connection credentials of the Pack.
    • Patch the system connection credentials of the Pack.
    • Retrieve the system connection metadata of the Pack.
    • Retrieve the logs of a Pack.
    • Retrieve the grouped logs of a Pack.
  • Publishing
    • Get doc categories
    • Unpublish doc
    • Publish doc
  • Docs
    • Get info about a doc
    • Delete doc
    • Update doc
    • Create doc
    • List available docs
  • Account
    • Get user info
  1. Rows

List table rows

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
GET
/docs/{docId}/tables/{tableIdOrName}/rows
Returns a list of rows in a table.

Value results#

The valueFormat parameter dictates in what format the API should return values for individual cells.
simple (default): Returns cell values as the following JSON values: string, number, or boolean. Array values (like multiselects) are returned as comma-delimited strings.
simpleWithArrays: Singleton values are returned as simple. Array values are returned as JSON arrays and the values within are simple values (including nested arrays).
rich: If applicable, returns many values with further encoding, allowing API users to have lossless access to data in Coda.
For text values, returns data in Markdown syntax. If the text field is simple text (e.g. has no formatting),
the field will be fully escaped with triple-ticks. E.g
```This is plain text```
For currency, lookup, image, person and hyperlink values, the value will be encoded in JSON-LD format.
  // Currency
  {
    "@context": "http://schema.org",
    "@type": "MonetaryAmount",
    "currency": "USD",
    "amount": 42.42
  }

  // Lookup
  {
    "@context": "http://schema.org",
    "@type": "StructuredValue",
    "additionalType": "row",
    "name": "Row Name",
    "rowId": "i-123456789",
    "tableId": "grid-123456789",
    "tableUrl": "https://coda.io/d/_d123456789/grid-123456789",
    "url": "https://coda.io/d/_d123456789/grid-123456789#_r42",
  }

  // Hyperlink
  {
    "@context": "http://schema.org",
    "@type": "WebPage",
    "name": "Coda",
    "url": "https://coda.io"
  }

  // Image
  {
    "@context": "http://schema.org",
    "@type": "ImageObject",
    "name": "Coda logo",
    "url": "https://coda.io/logo.jpg"
  }

  // People
  {
    "@context": "http://schema.org",
    "@type": "Person",
    "name": "Art Vandalay",
    "email": "art@vandalayindustries.com"
  }
请求示例请求示例
Shell
JavaScript
Java
Swift
curl -s -H 'Authorization: Bearer <your API token>' \
  -G --data-urlencode 'query=<column ID>:"Work out"' \
  'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/rows' |
  jq '"Matching rows: " + (.items | length | tostring)'
# => "Matching rows: 1"
响应示例响应示例
200 - 示例 1
{
    "nextPageToken": "eyJsaW1pd",
    "nextSyncToken": "eyJsaW1pd",
    "items": [
        {
            "id": "i-tuVwxYz",
            "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/rows/i-RstUv-W",
            "name": "Apple",
            "index": 7,
            "browserLink": "https://coda.io/d/_dAbCDeFGH#Teams-and-Tasks_tpqRst-U/_rui-tuVwxYz",
            "createdAt": "2018-04-11T00:18:57.946Z",
            "updatedAt": "2018-04-11T00:18:57.946Z",
            "type": "row",
            "values": {
                "c-tuVwxYz": "Apple",
                "c-bCdeFgh": [
                    "$12.34",
                    "$56.78"
                ]
            }
        }
    ],
    "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/rows?limit=20",
    "nextPageLink": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/rows?pageToken=eyJsaW1pd"
}

请求参数

Path 参数

Query 参数

返回响应

🟢200List of rows in the table.
application/json
Body

🟠400400
🟠401401
🟠403403
🟠404404
🟠429429
修改于 2024-03-20 08:13:15
上一页
Push a button
下一页
Insert/upsert rows
Built with