获取团队下项目列表

GET 
https://your-domain/openapi/v2/project/projects

获取团队下项目列表

History

Version	Changes
v3.14.117, v3.15.26	Added in: v3.14.117, v3.15.26

Request

Query Parameters

teamID stringrequired

团队ID

limit integer

Possible values: <= 500

Default value: 500

本次请求要返回的数量，默认值为500，超过500或小于等于0会被设置为500

cursor string

本次请求的起始位置

Responses

200

请求成功

application/json

Schema

Schema

data

object

list

object[]

Array [

id string

项目ID

name string

项目名称

createTime integer

项目创建时间

owner

object

id string

项目负责人ID

name string

项目负责人名称

creator

object

id string

项目创建者ID

name string

项目创建者名称

status

object

id string

项目状态ID

name string

项目状态名称

category string

项目状态分类

statusCategory string

项目状态分类

stickToTop boolean

是否置顶

isArchive boolean

是否归档

archiveUser

object

id string

归档人ID

name string

归档人名称

archiveTime integer

归档时间

plannedStartDate integer

项目计划开始时间,例"2023-05-06"

plannedEndDate integer

项目计划完成时间,例"2023-05-06"

customField

object

项目自定义属性

property name*

object

oneOf

MOD1

字符串类型的自定义字段值（单行，多行文本）

string

MOD2

数字类型的自定义字段值(时间，日期，整数，浮点数等)

number

MOD3

对象类型的自定义字段值（单选，多选）

object

]

PageInfo

object

count integer

本次返回的数量

endCursor string

本页最后一个光标，用于翻页

hasNextPage boolean

是否有下一页

startCursor string

本页第一个光标，用于翻页

totalCount integer

整个集合总数，包括本次响应中返回的

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

errorData object

本次请求错误元数据

Example (from schema)

[
  {
    "result": "SUCCESS",
    "data": {
      "list": [
        {
          "id": "5f1b0b5b",
          "name": "project1",
          "createTime": 1691726809,
          "owner": {
            "id": "1b2b2b29",
            "name": "owner"
          },
          "creator": {
            "id": "1b2b2b29",
            "name": "creator"
          },
          "status": {
            "id": "to_do",
            "name": "To Do",
            "category": "to_do"
          },
          "statusCategory": "to_do",
          "stickToTop": false,
          "isArchive": false,
          "archiveUser": {
            "id": "5h2b2b29",
            "name": "archiveUser"
          },
          "archiveTime": 1691726809,
          "plannedStartDate": "2023-01-01",
          "plannedEndDate": "2023-01-31"
        }
      ],
      "pageInfo": {
        "count": 1,
        "endCursor": "sample_end_cursor",
        "hasNextPage": false,
        "startCursor": "sample_start_cursor",
        "totalCount": 1
      }
    }
  }
]

401

如果身份验证凭据不正确或丢失，则返回

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Unauthorized",
  "errorMsg": "Access token is invalid"
}

403

如果scope检验不通过，则返回

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Forbidden",
  "errorMsg": "Scope is invalid"
}

404

如果未找到资源对象，则返回

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "NotFound",
  "errorMsg": "Not Found"
}

500

内部服务器错误

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Internal Server Error",
  "errorMsg": "Internal Server Error"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://your-domain/openapi/v2/project/projects' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://your-domain/openapi/v2

Auth

Bearer Token

Parameters

teamID — queryrequired

limit — query

cursor — query

ResponseClear

Click the Send API Request button above and see the response here!