Coda
  1. Packs
Coda
  • Permissions
    • Get sharing metadata
    • Delete permission
    • Search principals
    • Get ACL settings
    • Update ACL settings
    • List permissions
    • Add permission
  • Pages
    • Content export status
    • List pages
    • Create a page
    • Begin content export
    • Get a page
    • Delete a page
    • Update a page
  • Tables
    • List tables
    • Get a table
  • Columns
    • List columns
    • Get a column
  • Rows
    • Push a button
    • List table rows
    • Insert/upsert rows
    • Delete multiple rows
    • Get a row
    • Delete row
    • Update row
  • 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
      GET
    • Create Pack
      POST
    • Gets the JSON Schema for Pack configuration.
      GET
    • List the versions for a Pack.
      GET
    • Get the next valid version for a Pack.
      POST
    • Get the difference between two pack versions.
      GET
    • Register Pack version
      POST
    • Pack version upload complete
      POST
    • Create a new Pack release.
      POST
    • List the releases for a Pack.
      GET
    • Update an existing Pack release.
      PUT
    • Set the OAuth configurations of the Pack.
      PUT
    • Retrieve the OAuth configuration of the Pack.
      GET
    • List permissions for a Pack
      GET
    • Add a permission for Pack
      POST
    • Delete a permission for Pack
      DELETE
    • List makers for Pack
      GET
    • Add a maker for Pack
      POST
    • Delete a maker for Pack
      DELETE
    • List categories for Pack
      GET
    • Add a category for Pack
      POST
    • Delete a category for Pack
      DELETE
    • Upload a Pack asset.
      POST
    • Upload Pack source code.
      POST
    • Pack asset upload complete
      POST
    • Pack source code upload complete
      POST
    • get the source code for a Pack version.
      GET
    • List the Pack listings accessible to a user.
      GET
    • Get detailed listing information for a Pack.
      GET
    • List featured docs for a Pack
      GET
    • Update featured docs for a Pack
      PUT
    • Get a single Pack
      GET
    • Update Pack
      PATCH
    • Delete Pack
      DELETE
    • Set the system connection credentials of the Pack.
      PUT
    • Patch the system connection credentials of the Pack.
      PATCH
    • Retrieve the system connection metadata of the Pack.
      GET
    • Retrieve the logs of a Pack.
      GET
    • Retrieve the grouped logs of a Pack.
      GET
  • 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. Packs

List Packs

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
GET
/packs
Packs
Get the list of accessible Packs.
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://dev-cn.your-api-server.com/packs'
响应示例响应示例
200 - 示例 1
{
    "nextPageToken": "eyJsaW1pd",
    "items": [
        {
            "sourceCodeVisibility": "private",
            "id": 1003,
            "logoUrl": "string",
            "coverUrl": "string",
            "exampleImages": [
                {
                    "filename": "string",
                    "imageUrl": "string",
                    "assetId": "string",
                    "altText": "string",
                    "mimeType": "image/jpeg"
                }
            ],
            "workspaceId": "ws-asdf",
            "categories": [
                {
                    "categoryId": "aBCdEFg",
                    "categoryName": "Project management",
                    "categorySlug": "project-management"
                }
            ],
            "certified": true,
            "name": "Cool Geometry Formulas",
            "description": "This Pack allows users to calculate the surface area and volume of a few common 3D shapes, like cubes and pyramids.",
            "shortDescription": "Calculate cool geometric formulas like surface area.",
            "supportEmail": "user@email.com",
            "termsOfServiceUrl": "string",
            "privacyPolicyUrl": "string"
        }
    ],
    "nextPageLink": "https://coda.io/apis/v1/packs?pageToken=xyz"
}

请求参数

Query 参数
accessType
enum<string> 
可选
Deprecated, use accessTypes instead. Filter to only return the Packs for which the current user has this access type
枚举值:
viewtesteditadmin
accessTypes
array[string]
可选
Filter to only return the Packs for which the current user has these access types.
枚举值:
viewtesteditadmin
示例值:
edit
sortBy
enum<string> 
可选
The sort order of the Packs returned.
枚举值:
titlecreatedAtupdatedAt
limit
integer 
可选
Maximum number of results to return in this query.
>= 1
默认值:
25
示例值:
10
direction
enum<string> 
可选
Direction to sort results in.
枚举值:
ascendingdescending
pageToken
string 
可选
An opaque token used to fetch the next page of results.
示例值:
eyJsaW1pd
onlyWorkspaceId
string 
可选
Use only this workspace (not all of a user's workspaces) to check for Packs shared via workspace ACL.
parentWorkspaceIds
array[string]
可选
Filter to only Packs whose parent workspace is one of the given IDs.
excludePublicPacks
boolean 
可选
Only get Packs shared with users/workspaces, not publicly.
excludeIndividualAcls
boolean 
可选
Do not include Packs that are only shared with the user individually.
excludeWorkspaceAcls
boolean 
可选
Do not include Packs that are only shared with workspaces.

返回响应

🟢200List of Pack summaries.
application/json
Body
List of Pack summaries.
nextPageToken
string 
可选
If specified, an opaque token used to fetch the next page of results.
示例值:
eyJsaW1pd
items
array[object (PackSummary) {14}] 
必需
sourceCodeVisibility
enum<string> 
可选
Visibility of a pack's source code.
枚举值:
privateshared
id
number 
必需
ID of the Pack.
示例值:
1003
logoUrl
string <url>
可选
The link to the logo of the Pack.
coverUrl
string <url>
可选
The link to the cover photo of the Pack.
exampleImages
array[object (PackImageFile) {5}] 
可选
The example images for the Pack.
workspaceId
string 
必需
The parent workspace for the Pack.
示例值:
ws-asdf
categories
array[object (PublishingCategory) {3}] 
必需
Publishing categories associated with this Pack.
certified
boolean 
可选
Denotes if the pack is certified by Coda.
name
string 
必需
The name of the Pack.
<= 128 字符
示例值:
Cool Geometry Formulas
description
string 
必需
The full description of the Pack.
<= 8192 字符
示例值:
This Pack allows users to calculate the surface area and volume of a few common 3D shapes, like cubes and pyramids.
shortDescription
string 
必需
A short version of the description of the Pack.
<= 256 字符
示例值:
Calculate cool geometric formulas like surface area.
supportEmail
string 
可选
A contact email for the Pack.
<= 512 字符
示例值:
user@email.com
termsOfServiceUrl
string <url>
可选
A Terms of Service URL for the Pack.
<= 512 字符
privacyPolicyUrl
string <url>
可选
A Privacy Policy URL for the Pack.
<= 512 字符
nextPageLink
string <url>
可选
If specified, a link that can be used to fetch the next page of results.
示例值:
https://coda.io/apis/v1/packs?pageToken=xyz
🟠400400
🟠401401
🟠429429
修改于 2024-03-20 08:13:15
上一页
Updates user role
下一页
Create Pack
Built with