List pages

开发环境

http://dev-cn.your-api-server.com

GET

/docs/{docId}/pages

Returns a list of pages in a Coda doc.

请求示例

Shell

JavaScript

Java

Swift

curl -s -H 'Authorization: Bearer <your API token>' \
  'https://coda.io/apis/v1/docs/<doc ID>/pages' |
  jq '.items[0].name'
# => "Page 1"

响应示例

200 - 示例 1

{
    "nextPageToken": "eyJsaW1pd",
    "items": [
        {
            "icon": {
                "name": "string",
                "type": "string",
                "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"
            },
            "image": {
                "browserLink": "https://codahosted.io/docs/nUYhlXysYO/blobs/bl-lYkYKNzkuT/3f879b9ecfa27448",
                "type": "string",
                "width": 800,
                "height": 600
            },
            "contentType": "canvas",
            "parent": {
                "id": "canvas-IjkLmnO",
                "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
                "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
                "name": "Launch Status",
                "type": "page"
            },
            "createdBy": {
                "@type": "ImageObject",
                "@context": "http://schema.org/",
                "additionalType": "string",
                "name": "Alice Atkins",
                "email": "alice@atkins.com"
            },
            "updatedBy": {
                "@type": "ImageObject",
                "@context": "http://schema.org/",
                "additionalType": "string",
                "name": "Alice Atkins",
                "email": "alice@atkins.com"
            },
            "id": "canvas-IjkLmnO",
            "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
            "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
            "name": "Launch Status",
            "subtitle": "See the status of launch-related tasks.",
            "isHidden": true,
            "isEffectivelyHidden": true,
            "children": [
                {
                    "id": "canvas-IjkLmnO",
                    "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
                    "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO",
                    "name": "Launch Status",
                    "type": "page"
                }
            ],
            "authors": [
                {
                    "@type": "ImageObject",
                    "@context": "http://schema.org/",
                    "additionalType": "string",
                    "name": "Alice Atkins",
                    "email": "alice@atkins.com"
                }
            ],
            "createdAt": "2018-04-11T00:18:57.946Z",
            "updatedAt": "2018-04-11T00:18:57.946Z",
            "type": "page"
        }
    ],
    "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages?limit=20",
    "nextPageLink": "https://coda.io/apis/v1/docs/AbCDeFGH/pages?pageToken=eyJsaW1pd"
}

请求参数

Path 参数

Query 参数

返回响应

🟢200List of pages.

application/json

Body

🟠401401

🟠403403

🟠404404

🟠429429

修改于 2024-03-20 08:13:15

Content export status

Create a page