开发者 REST API 项目 API 项目和项目设置、项目成员、项目工具、项目启用的任务类型、版本和快速访问。
由群历 REST API 的 OpenAPI 契约(openapi/qunli-api.yaml,qunli-api 提交 f18e40d)生成。路径都相对于 https://qunli.co;认证见认证 ,响应包装、分页和错误格式见约定 。字段说明是契约里的英文原文。
项目 GET /api/v1/accounts/{account_id}/projectsList accessible projects in the account
参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 status查询 active | archived否
响应 POST /api/v1/accounts/{account_id}/projectsCreate a project
参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。
请求体application/json,必填 字段 类型 必填 说明 projectProjectInput是 Writable attributes for create/update (wrapped under project). project.namestring 否 project.iconstring | null 否 project.colorstring | null 否 project.stagestring 否 project.statusstring 否 project.descriptionstring | null 否 project.start_datestring (date) | null 否 project.target_datestring (date) | null 否 project.visibilitystring 否 project.project_typestring 否 project.task_type_idsstring (uuid)[] 否 project.cover_urlstring | null 否 https URL of a gallery cover image. Setting it removes an uploaded cover; send it and cover_image as null to remove the cover. project.cover_imagestring | null 否 Active Storage direct-upload signed_id of an uploaded cover image (JPG, PNG, WebP, GIF or AVIF, at most 20MB). Clears cover_url. project.cover_positioninteger 否 Vertical focal point of the cover, 0 (top) to 100 (bottom).
响应 GET /api/v1/accounts/{account_id}/projects/{id}Fetch a project
参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 id路径 string 是
响应 PATCH /api/v1/accounts/{account_id}/projects/{id}Update a project
参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 id路径 string 是
请求体application/json,必填 字段 类型 必填 说明 projectProjectInput是 Writable attributes for create/update (wrapped under project). project.namestring 否 project.iconstring | null 否 project.colorstring | null 否 project.stagestring 否 project.statusstring 否 project.descriptionstring | null 否 project.start_datestring (date) | null 否 project.target_datestring (date) | null 否 project.visibilitystring 否 project.project_typestring 否 project.task_type_idsstring (uuid)[] 否 project.cover_urlstring | null 否 https URL of a gallery cover image. Setting it removes an uploaded cover; send it and cover_image as null to remove the cover. project.cover_imagestring | null 否 Active Storage direct-upload signed_id of an uploaded cover image (JPG, PNG, WebP, GIF or AVIF, at most 20MB). Clears cover_url. project.cover_positioninteger 否 Vertical focal point of the cover, 0 (top) to 100 (bottom).
响应 DELETE /api/v1/accounts/{account_id}/projects/{id}Delete a project (into 已删除的项目 for 30 days)
Moves the project to the team's deleted projects: it disappears for everyone at once and can be restored for 30 days (POST /trashed_projects/{id}/restoration), then it is purged with everything in it. Human project admins and team owners/admins only; robots get 403. To keep a finished project readable, archive it instead (PATCH status archived).
参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 id路径 string 是
响应 PUT /api/v1/accounts/{account_id}/projects/{id}/update_task_typesReplace the project's enabled task types (legacy verb path; see api-conventions §9)
Project admins and team owners/admins only; others get 403.
参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 id路径 string 是
请求体application/json,必填 字段 类型 必填 说明 task_type_idsstring (uuid)[] 是
响应 项目设置 GET /api/v1/accounts/{account_id}/projects/{project_id}/config参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是
响应 PATCH /api/v1/accounts/{account_id}/projects/{project_id}/configProject admins and team owners/admins only; others get 403.
参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是
请求体application/json,必填 字段 类型 必填 说明 project_configobject 否
响应 成员 GET /api/v1/accounts/{account_id}/members参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。
响应 状态 说明 返回 200Members across the account's projects data: Member []401Missing or invalid authentication. ProblemDetails
GET /api/v1/accounts/{account_id}/projects/{project_id}/members参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是
响应 POST /api/v1/accounts/{account_id}/projects/{project_id}/membersProject admins and team owners/admins only (403 otherwise). user_id must be an active or paused member of the team (422 otherwise).
参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是
请求体application/json,必填 字段 类型 必填 说明 memberobject 是 member.user_idstring (uuid) 否 member.rolestring 否
响应 GET /api/v1/accounts/{account_id}/projects/{project_id}/members/{id}参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是 id路径 string 是
响应 PATCH /api/v1/accounts/{account_id}/projects/{project_id}/members/{id}Changes the member's project role (admin 管理员, member 成员, reader 仅查看). Project admins and team owners/admins only; others get 403. Granting or removing admin is for people: an agent gets 403 whatever its role. Agents can't be made project admins (403), and demoting the project's last admin who is still in the team is 409.
参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是 id路径 string 是
请求体application/json,必填 字段 类型 必填 说明 memberobject 是 member.roleadmin | member | reader否
响应 DELETE /api/v1/accounts/{account_id}/projects/{project_id}/members/{id}Project admins and team owners/admins only; others get 403. Removing the project's last admin who is still in the team is 409.
参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是 id路径 string 是
响应 参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是
响应 参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是 id路径 string 是
响应 Project admins and team owners/admins only; others get 403.
参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是 id路径 string 是
请求体application/json,必填 字段 类型 必填 说明 toolobject 是 tool.namestring 否 tool.slugstring 否 tool.descriptionstring 否 tool.statusstring | null 否
响应 Disable a tool (sets status null; returns the tool)
Project admins and team owners/admins only; others get 403.
参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是 id路径 string 是
响应 项目的任务类型 GET /api/v1/accounts/{account_id}/projects/{project_id}/task_types参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是
响应 POST /api/v1/accounts/{account_id}/projects/{project_id}/task_typesProject admins and team owners/admins only; others get 403.
参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是
请求体application/json,必填 字段 类型 必填 说明 project_task_typeobject 是 project_task_type.task_type_idstring (uuid) 否
响应 GET /api/v1/accounts/{account_id}/projects/{project_id}/task_types/{id}参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是 id路径 string 是
响应 PATCH /api/v1/accounts/{account_id}/projects/{project_id}/task_types/{id}Project admins and team owners/admins only; others get 403.
参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是 id路径 string 是
请求体application/json,必填 字段 类型 必填 说明 project_task_typeobject 否
响应 DELETE /api/v1/accounts/{account_id}/projects/{project_id}/task_types/{id}Project admins and team owners/admins only; others get 403.
参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是 id路径 string 是
响应 版本 GET /api/v1/accounts/{account_id}/projects/{project_id}/versions参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是
响应 POST /api/v1/accounts/{account_id}/projects/{project_id}/versions参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是
请求体application/json,必填 字段 类型 必填 说明 versionobject 是 version.namestring 否 version.statusstring 否 version.descriptionstring 否 version.start_datestring 否 version.effective_datestring 否
响应 GET /api/v1/accounts/{account_id}/projects/{project_id}/versions/{id}参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是 id路径 string 是
响应 PATCH /api/v1/accounts/{account_id}/projects/{project_id}/versions/{id}参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是 id路径 string 是
请求体application/json,必填 字段 类型 必填 说明 versionobject 是 Only the fields sent change. version.namestring 否 version.statusactive | archived | trashed否 version.descriptionstring | null 否 version.start_datestring (date) | null 否 version.effective_datestring (date) | null 否
响应 DELETE /api/v1/accounts/{account_id}/projects/{project_id}/versions/{id}参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 project_id路径 string 是 id路径 string 是
响应 快速访问 GET /api/v1/accounts/{account_id}/quick_accesses参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。
响应 POST /api/v1/accounts/{account_id}/quick_accesses参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。
请求体application/json,必填 字段 类型 必填 说明 quick_accessobject 是 quick_access.project_idstring (uuid) 否
响应 DELETE /api/v1/accounts/{account_id}/quick_accesses/{id}Remove a quick access (id is the project_id)
参数 参数 位置 类型 必填 说明 account_id路径 string 是 团队的数字 id,和网页地址里的相同,例如 2025。 id路径 string 是
响应 状态 说明 返回 200Removed data: object 401Missing or invalid authentication. ProblemDetails404Resource does not exist or has been trashed. ProblemDetails
数据结构 上面的响应用到的对象。字段的类型是另一个对象时,它也列在这里。
Project字段 类型 必填 说明 idstring (uuid) 是 public_idstring 是 account_idstring (uuid) 是 account_public_idstring 是 namestring 是 cover_urlstring | null 是 cover_positioninteger 是 iconstring | null 是 colorstring | null 是 visibilityinvite_only | team是 project_typeproject | team_space | headquarter是 parent_idstring (uuid) | null 是 parent_public_idstring | null 是 descriptionstring | null 是 stagebacklog | planning | in_progress | completed | cancelled是 statusactive | archived | trashed是 start_datestring (date) | null 是 target_datestring (date) | null 是 creator_idstring (uuid) 是 created_atstring (date-time) 是 updated_atstring (date-time) 是 toolsTool []是 membersMember []是 versionsVersion []是 task_type_idsstring (uuid)[] 是 Task types enabled in this project, in the team's task type order. The first is the default type of a task created without task_type_id.
TrashedProject字段 类型 必填 说明 idstring (uuid) 是 public_idstring 是 account_idstring (uuid) 是 namestring 是 iconstring | null 是 colorstring | null 是 visibilityinvite_only | team是 project_typestring 是 deleted_byUserRef是 trashed_atstring (date-time) | null 是 purge_atstring (date-time) | null 是 restores_toactive | archived是 can_restoreboolean 是 can_purgeboolean 是
ProjectConfig字段 类型 必填 说明 idstring (uuid) 是 project_idstring (uuid) 是 iteration_starts_oninteger 是 iteration_length_in_weeksinteger 是 iteration_auto_create_countinteger 是 created_atstring (date-time) 是 updated_atstring (date-time) 是
Member字段 类型 必填 说明 idstring (uuid) 是 user_idstring (uuid) 是 project_idstring (uuid) 是 rolestring 是
字段 类型 必填 说明 idstring (uuid) 是 namestring | null 是 slugstring | null 是 descriptionstring | null 是 statusstring | null 是 positioninteger 是 project_idstring (uuid) 是 project_public_idstring 是 created_atstring (date-time) 是 updated_atstring (date-time) 是
ProjectTaskType字段 类型 必填 说明 idstring (uuid) 是 project_idstring (uuid) 是 task_type_idstring (uuid) 是 created_atstring (date-time) 是 updated_atstring (date-time) 是
Version字段 类型 必填 说明 idstring (uuid) 是 namestring 是 descriptionstring | null 是 statusstring 是 start_datestring (date) | null 是 effective_datestring (date) | null 是 project_idstring (uuid) 是 created_atstring (date-time) 是 updated_atstring (date-time) 是
QuickAccess字段 类型 必填 说明 project_idstring (uuid) 是 project_public_idstring 是 namestring 是 iconstring | null 是 account_idstring (uuid) 是 account_public_idstring 是 created_atstring (date-time) 是 updated_atstring (date-time) 是
UserRef字段 类型 必填 说明 idstring (uuid) 是 User UUID. public_idstring | null 是 Member ref ("U12") in this account. namestring | null 是 avatar_urlstring | null 是 kindhuman | agent | null是 null only for an unknown (deleted) user.