List available 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).

{ "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 参数

isOwner

boolean

可选

Show only docs owned by the user.

isPublished

boolean

可选

Show only published docs.

query

string

可选

Search term used to filter down results.

示例值:

Supercalifragilisticexpialidocious

sourceDoc

string

可选

Show only docs copied from the specified doc ID.

isStarred

boolean

可选

If true, returns docs that are starred. If false, returns docs that are not starred.

inGallery

boolean

可选

Show only docs visible within the gallery.

workspaceId

string

可选

Show only docs belonging to the given workspace.

folderId

string

可选

Show only docs belonging to the given folder.

limit

integer

可选

Maximum number of results to return in this query.

>= 1

默认值:

示例值:

pageToken

string

可选

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

示例值:

eyJsaW1pd

返回响应

🟢200List of Coda docs matching the query.

application/json

Body

List of Coda docs.

nextPageToken

string

可选

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

示例值:

eyJsaW1pd

items

array[object (Doc) {17}]

必需

icon

object (Icon)

可选

Info about the icon.

docSize

object (DocSize)

可选

The number of components within a Coda doc.

published

object (DocPublished)

可选

Information about the publishing state of the document.

folder

object (FolderReference)

必需

Reference to a Coda folder.

workspace

object (WorkspaceReference)

必需

Reference to a Coda workspace.

string

必需

ID of the Coda doc.

示例值:

AbCDeFGH

href

string <url>

必需

API link to the Coda doc.

示例值:

https://coda.io/apis/v1/docs/AbCDeFGH

browserLink

string <url>

必需

Browser-friendly link to the Coda doc.

示例值:

https://coda.io/d/_dAbCDeFGH

name

string

必需

Name of the doc.

示例值:

Product Launch Hub

owner

string <email>

必需

Email address of the doc owner.

示例值:

user@example.com

ownerName

string

必需

Name of the doc owner.

示例值:

Some User

createdAt

string <date-time>

必需

Timestamp for when the doc was created.

示例值:

2018-04-11T00:18:57.946Z

updatedAt

string <date-time>

必需

Timestamp for when the doc was last modified.

示例值:

2018-04-11T00:18:57.946Z

workspaceId

string

已废弃

ID of the Coda workspace containing this doc.

示例值:

ws-1Ab234

folderId

string

已废弃

ID of the Coda folder containing this doc.

示例值:

fl-1Ab234

type

enum<string>

必需

The type of this resource.

枚举值:

doc

sourceDoc

object

可选

Reference to a Coda doc.

href

string <url>

可选

API link to these results

示例值:

https://coda.io/apis/v1/docs?limit=20

nextPageLink

string <url>

可选

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

示例值:

https://coda.io/apis/v1/docs?pageToken=eyJsaW1pd

🟠401401

🟠403403

🟠404404

🟠429429