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 the Pack listings accessible to a user.

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
GET
/packs/listings
Packs
Get listings of public Packs and Packs created by you.
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://dev-cn.your-api-server.com/packs/listings'
响应示例响应示例
200 - 示例 1
{
    "nextPageToken": "eyJsaW1pd",
    "items": [
        {
            "minimumFeatureSet": "Basic",
            "unrestrictedFeatureSet": "Basic",
            "standardPackPlan": {
                "packPlanId": "string",
                "packId": 0,
                "createdAt": "2018-04-11T00:18:57.946Z",
                "pricing": {
                    "type": "Free"
                }
            },
            "bundledPackPlan": {
                "pricing": {
                    "minimumFeatureSet": "Pro",
                    "type": "BundledWithTier"
                },
                "packPlanId": "string",
                "packId": 0,
                "createdAt": "2018-04-11T00:18:57.946Z"
            },
            "sourceCodeVisibility": "private",
            "packId": 1003,
            "packVersion": "1.0.3",
            "releaseId": 2,
            "lastReleasedAt": "2018-04-11T00:18:57.946Z",
            "logoUrl": "string",
            "coverUrl": "string",
            "exampleImages": [
                {
                    "filename": "string",
                    "imageUrl": "string",
                    "assetId": "string",
                    "altText": "string",
                    "mimeType": "image/jpeg"
                }
            ],
            "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",
            "categories": [
                {
                    "categoryId": "aBCdEFg",
                    "categoryName": "Project management",
                    "categorySlug": "project-management"
                }
            ],
            "makers": [
                {
                    "name": "John Doe",
                    "pictureLink": "https://cdn.coda.io/avatars/default_avatar.png",
                    "slug": "string",
                    "jobTitle": "string",
                    "employer": "string",
                    "description": "string"
                }
            ],
            "certified": true,
            "externalMetadataUrl": "https://codahosted.io/packs/12345/1.2.3/metadata/0c892064aa5cb.json",
            "sdkVersion": "1.5.1"
        }
    ],
    "nextPageLink": "https://coda.io/apis/v1/packs/listings?pageToken=xyz"
}

请求参数

Query 参数
packAccessTypes
array[string]
可选
Pack access types.
枚举值:
viewtesteditadmin
packIds
array[integer]
可选
Which Pack IDs to fetch.
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.
excludeWorkspaceAcls
boolean 
可选
Do not include Packs that are only shared with workspaces.
excludeIndividualAcls
boolean 
可选
Do not include Packs that are only shared with the user individually.
sortBy
enum<string> 
可选
Specify a sort order for the returned Pack listings returned.
枚举值:
packIdnamepackVersionpackVersionModifiedAt
orderBy
enum<string> 
可选
Deprecated: use sortBy instead.
枚举值:
packIdnamepackVersionpackVersionModifiedAt
direction
enum<string> 
可选
Direction to sort results in.
枚举值:
ascendingdescending
limit
integer 
可选
Maximum number of results to return in this query.
>= 1
默认值:
25
示例值:
10
pageToken
string 
可选
An opaque token used to fetch the next page of results.
示例值:
eyJsaW1pd

返回响应

🟢200Public Pack listings and Pack listings created by you.
application/json
Body
A list of Pack listings.
nextPageToken
string 
可选
If specified, an opaque token used to fetch the next page of results.
示例值:
eyJsaW1pd
items
array[object (PackListing) {23}] 
必需
minimumFeatureSet
enum<string> 
已废弃
Only relevant for original Coda packs.
枚举值:
BasicProTeamEnterprise
unrestrictedFeatureSet
enum<string> 
已废弃
Only relevant for original Coda packs.
枚举值:
BasicProTeamEnterprise
standardPackPlan
object (StandardPackPlan) 
可选
The Pack plan to show the Pack can be subscribed to at a monthly cost per Doc Maker or for free.
bundledPackPlan
object (BundledPackPlan) 
可选
The Pack plan to show the Pack can be accessed if the workspace is at least the given tier.
sourceCodeVisibility
enum<string> 
可选
Visibility of a pack's source code.
枚举值:
privateshared
packId
number 
必需
ID of the Pack.
示例值:
1003
packVersion
string 
必需
The version of the Pack.
示例值:
1.0.3
releaseId
number 
可选
The current release number of the Pack if released, otherwise undefined.
示例值:
2
lastReleasedAt
string <date-time>
可选
The timestamp of the latest release of this Pack.
示例值:
2018-04-11T00:18:57.946Z
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.
name
string 
必需
The name of the Pack.
示例值:
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.
示例值:
Calculate cool geometric formulas like surface area.
supportEmail
string 
可选
A contact email for the Pack.
示例值:
user@email.com
termsOfServiceUrl
string <url>
可选
A Terms of Service URL for the Pack.
privacyPolicyUrl
string <url>
可选
A Privacy Policy URL for the Pack.
categories
array[object (PublishingCategory) {3}] 
必需
Publishing Categories associated with this Pack.
makers
array[object (MakerSummary) {6}] 
必需
Makers associated with this Pack.
certified
boolean 
可选
Denotes if the pack is certified by Coda.
externalMetadataUrl
string 
必需
The URL where complete metadata about the contents of the Pack version can be downloaded.
示例值:
https://codahosted.io/packs/12345/1.2.3/metadata/0c892064aa5cb.json
sdkVersion
string 
必需
What Packs SDK version was this version built on.
示例值:
1.5.1
nextPageLink
string <url>
可选
If specified, a link that can be used to fetch the next page of results.
示例值:
https://coda.io/apis/v1/packs/listings?pageToken=xyz
🟠400400
🟠401401
🟠403403
🟠404404
🟠429429
修改于 2024-03-20 08:13:15
上一页
get the source code for a Pack version.
下一页
Get detailed listing information for a Pack.
Built with