List available docs

开发环境

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

GET

/docs

Returns a list of Coda docs accessible by the user. These are returned in the same order as on the docs page: reverse chronological by the latest event relevant to the user (last viewed, edited, or shared).

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

200 - 示例 1

{
    "nextPageToken": "eyJsaW1pd",
    "items": [
        {
            "icon": {
                "name": "string",
                "type": "string",
                "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"
            },
            "docSize": {
                "totalRowCount": 31337,
                "tableAndViewCount": 42,
                "pageCount": 10,
                "overApiSizeLimit": false
            },
            "published": {
                "mode": "view",
                "description": "Hello World!",
                "browserLink": "https://coda.io/@coda/hello-world",
                "imageLink": "string",
                "discoverable": true,
                "earnCredit": true,
                "categories": [
                    "Project Management"
                ]
            },
            "folder": {
                "id": "fl-1Ab234",
                "browserLink": "https://coda.io/docs?folderId=fl-1Ab234",
                "name": "My docs",
                "type": "folder"
            },
            "workspace": {
                "id": "ws-1Ab234",
                "organizationId": "org-2Bc456",
                "browserLink": "https://coda.io/docs?workspaceId=ws-1Ab234",
                "name": "My workspace",
                "type": "workspace"
            },
            "id": "AbCDeFGH",
            "href": "https://coda.io/apis/v1/docs/AbCDeFGH",
            "browserLink": "https://coda.io/d/_dAbCDeFGH",
            "name": "Product Launch Hub",
            "owner": "user@example.com",
            "ownerName": "Some User",
            "createdAt": "2018-04-11T00:18:57.946Z",
            "updatedAt": "2018-04-11T00:18:57.946Z",
            "workspaceId": "ws-1Ab234",
            "folderId": "fl-1Ab234",
            "type": "doc",
            "sourceDoc": {
                "id": "AbCDeFGH",
                "href": "https://coda.io/apis/v1/docs/AbCDeFGH",
                "browserLink": "https://coda.io/d/_dAbCDeFGH",
                "type": "doc"
            }
        }
    ],
    "href": "https://coda.io/apis/v1/docs?limit=20",
    "nextPageLink": "https://coda.io/apis/v1/docs?pageToken=eyJsaW1pd"
}

请求参数

Query 参数

返回响应

🟢200List of Coda docs matching the query.

application/json

Body

🟠401401

🟠403403

🟠404404

🟠429429

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

Create doc

Get user info