Coda
  1. Pages
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. Pages

Get a page

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
GET
/docs/{docId}/pages/{pageIdOrName}
Pages
Returns details about a page.
请求示例请求示例
Python
Shell
JavaScript
Java
curl --location --request GET 'http://dev-cn.your-api-server.com/docs/AbCDeFGH/pages/canvas-IjkLmnO'
响应示例响应示例
200 - 示例 1
{
    "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"
}

请求参数

Path 参数
docId
string 
必需
ID of the doc.
示例值:
AbCDeFGH
pageIdOrName
string 
必需
ID or name of the page. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected.
示例值:
canvas-IjkLmnO

返回响应

🟢200Info about a page.
application/json
Body
Metadata about a page.
icon
object (Icon) 
可选
Info about the icon.
name
string 
必需
Name of the icon.
type
string 
必需
MIME type of the icon
browserLink
string <url>
必需
Browser-friendly link to an icon.
示例值:
https://cdn.coda.io/icons/png/color/icon-32.png
image
object (Image) 
可选
Info about the image.
browserLink
string <url>
必需
Browser-friendly link to an image.
示例值:
https://codahosted.io/docs/nUYhlXysYO/blobs/bl-lYkYKNzkuT/3f879b9ecfa27448
type
string 
可选
MIME type of the image.
width
number 
可选
The width in pixels of the image.
示例值:
800
height
number 
可选
The height in pixels of the image.
示例值:
600
contentType
enum<string> 
必需
The type of a page in a doc.
枚举值:
canvasembedsyncPage
parent
object (PageReference) 
可选
Reference to a page.
id
string 
必需
ID of the page.
示例值:
canvas-IjkLmnO
href
string <url>
必需
API link to the page.
示例值:
https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO
browserLink
string <url>
必需
Browser-friendly link to the page.
示例值:
https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO
name
string 
必需
Name of the page.
示例值:
Launch Status
type
enum<string> 
必需
The type of this resource.
枚举值:
page
createdBy
object (PersonValue) 
可选
A named reference to a person, where the person is identified by email address.
@type
enum<string> 
LinkedDataType
必需
A schema.org identifier for the object.
枚举值:
ImageObjectMonetaryAmountPersonWebPageStructuredValue
@context
string 
必需
A url describing the schema context for this object, typically "http://schema.org/".
示例值:
http://schema.org/
additionalType
string 
可选
An identifier of additional type info specific to Coda that may not be present in a schema.org taxonomy,
name
string 
必需
The full name of the person.
示例值:
Alice Atkins
email
string 
必需
The email address of the person.
示例值:
alice@atkins.com
updatedBy
object (PersonValue) 
可选
A named reference to a person, where the person is identified by email address.
id
string 
必需
ID of the page.
示例值:
canvas-IjkLmnO
href
string <url>
必需
API link to the page.
示例值:
https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO
browserLink
string <url>
必需
Browser-friendly link to the page.
示例值:
https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO
name
string 
必需
Name of the page.
示例值:
Launch Status
subtitle
string 
可选
Subtitle of the page.
示例值:
See the status of launch-related tasks.
isHidden
boolean 
必需
Whether the page is hidden in the UI.
示例值:
true
isEffectivelyHidden
boolean 
必需
Whether the page or any of its parents is hidden in the UI.
示例值:
true
children
array[object (PageReference) {5}] 
必需
id
string 
必需
ID of the page.
示例值:
canvas-IjkLmnO
href
string <url>
必需
API link to the page.
示例值:
https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO
browserLink
string <url>
必需
Browser-friendly link to the page.
示例值:
https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO
name
string 
必需
Name of the page.
示例值:
Launch Status
type
enum<string> 
必需
The type of this resource.
枚举值:
page
authors
array[object (PersonValue) {5}] 
可选
Authors of the page
@type
enum<string> 
LinkedDataType
必需
A schema.org identifier for the object.
枚举值:
ImageObjectMonetaryAmountPersonWebPageStructuredValue
@context
string 
必需
A url describing the schema context for this object, typically "http://schema.org/".
示例值:
http://schema.org/
additionalType
string 
可选
An identifier of additional type info specific to Coda that may not be present in a schema.org taxonomy,
name
string 
必需
The full name of the person.
示例值:
Alice Atkins
email
string 
必需
The email address of the person.
示例值:
alice@atkins.com
createdAt
string <date-time>
可选
Timestamp for when the page was created.
示例值:
2018-04-11T00:18:57.946Z
updatedAt
string <date-time>
可选
Timestamp for when page content was last modified.
示例值:
2018-04-11T00:18:57.946Z
type
enum<string> 
必需
The type of this resource.
枚举值:
page
🟠401401
🟠403403
🟠404404
🟠410410
🟠429429
修改于 2024-03-20 08:13:15
上一页
Begin content export
下一页
Delete a page
Built with