列出项目

OpenAPI 契约

方法
GET
路径
/api/v1/projects
认证
jwtBearer (bearer) OR automationKey (bearer)
响应状态
200 400 401 403 404 409 429 500
请求与响应 Schema
JSON
{
  "requestBody": {},
  "responses": {
    "200": {
      "description": "Project page",
      "content": {
        "application/json": {}
      }
    },
    "400": {
      "description": "Invalid request",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RequestError"
        }
      }
    },
    "401": {
      "description": "Authentication required or invalid",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "403": {
      "description": "Authenticated but not permitted",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "404": {
      "description": "Requested project or build was not found",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    },
    "409": {
      "description": "Request conflicts with current project state",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    },
    "429": {
      "description": "HTTP rate limit or API-key NCU usage limit exceeded",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RateLimitError"
        }
      }
    },
    "500": {
      "description": "Unexpected server error",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    }
  }
}

GET /api/v1/projects 接受 JWT 或带 project:read 的 nfy_ 密钥。它按创建时间倒序返回通过 workspace membership 或直接 project grant 可见的项目。省略 workspaceId 时使用调用方的默认 workspace,也可显式选择另一个可读取 workspace。支持常规分页参数,默认页大小为 20。

每个内容可见项目包含已保存默认值、有效 role 与 capability、构建数量,以及存在时最近的非草稿构建摘要。普通 workspace member 无法看到没有直接 grant 的 restricted project,而仅有 billing membership 也不会暴露项目内容。

http
GET /api/v1/projects
Authorization: Bearer <access token>