Tables

List tables

Returns a list of tables in a document.

get/docs/{docId}/tables

Request

  • Base URL: https://docs.superhuman.com/apis/v1
  • URL: https://docs.superhuman.com/apis/v1/docs/{docId}/tables
  • Auth: HTTP bearer

Path parameters

docIdstring required

ID of the doc.

Query parameters

limitinteger

Maximum number of results to return in this query.

pageTokenstring

An opaque token used to fetch the next page of results.

sortBy'name'

Determines how the objects returned are sorted

Determines how to sort the given objects.

tableTypesTableType[]

Comma-separated list of table types to include in results. If omitted, includes tables, views, and databases.

Response

List of tables or views in a doc.

hrefstring url

API link to these results

nextPageTokenstring

If specified, an opaque token used to fetch the next page of results.

nextPageLinkstring url

If specified, a link that can be used to fetch the next page of results.

Example response

{
  "items": [
    {
      "id": "grid-pqRst-U",
      "href": "https://docs.superhuman.com/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U",
      "browserLink": "https://docs.superhuman.com/d/_dAbCDeFGH/#Teams-and-Tasks_tpqRst-U",
      "name": "Tasks",
      "parent": {
        "id": "canvas-IjkLmnO",
        "href": "https://docs.superhuman.com/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
        "browserLink": "https://docs.superhuman.com/d/_dAbCDeFGH/Launch-Status_sumnO",
        "name": "Launch Status"
      }
    }
  ],
  "href": "https://docs.superhuman.com/apis/v1/docs/AbCDeFGH/tables?limit=20",
  "nextPageToken": "eyJsaW1pd",
  "nextPageLink": "https://docs.superhuman.com/apis/v1/docs/AbCDeFGH/tables?pageToken=eyJsaW1pd"
}

Changes

No recorded changes to this operation across all 6 revisions of this API.