飞书 API

获取用户的OKR列表

GET

/open-apis/okr/v1/users/{user_id}/okrs

自建应用商店应用

根据用户的id获取OKR列表
使用tenant_access_token需要额外申请权限
以应用身份访问OKR信息

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/okr/v1/users/ou-asdasdasdasdasd/okrs?user_id_type=user_id&offset=0&limit=5&lang=zh_cn' \
--header 'Authorization;'

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "total": 5,
    "okr_list": [
      {
        "id": "11123123123123",
        "permission": 0,
        "period_id": "11123123123123",
        "name": "My OKR",
        "objective_list": [
          {
            "id": "1231231231231",
            "permission": 0,
            "content": "Objective 内容",
            "progress_report": "Objective 进度记录内容",
            "score": 100,
            "weight": 33.33,
            "progress_rate": {
              "percent": 50,
              "status": "1"
            },
            "kr_list": [
              {
                "id": "1231231223",
                "content": "KeyResult 内容",
                "score": 100,
                "weight": 100,
                "kr_weight": 33.33,
                "progress_rate": {
                  "percent": 50,
                  "status": "1"
                }
              }
            ],
            "aligned_objective_list": [
              {
                "id": "1231231231213",
                "okr_id": "12323231231213",
                "owner": {
                  "open_id": "od-asd2dasdasd",
                  "user_id": "ou-ux987dsf6x"
                }
              }
            ],
            "aligning_objective_list": [
              {
                "id": "1231231231213",
                "okr_id": "12323231231213",
                "owner": {
                  "open_id": "od-asd2dasdasd",
                  "user_id": "ou-ux987dsf6x"
                }
              }
            ]
          }
        ]
      }
    ]
  }
}

请求参数

Path 参数

user_id

必需

目标用户id 示例值："ou-asdasdasdasdasd"

示例值:

ou-asdasdasdasdasd

Query 参数

user_id_type

必需

用户 ID 类型示例值："open_id" 可选值有： open_id：用户的 open id union_id：用户的 union id user_id：用户的 user id people_admin_id：以people_admin_id来识别用户默认值：open_id 当值为 user_id，字段权限要求：获取用户 user ID

示例值:

user_id

offset

必需

请求列表的偏移，offset>=0，请求Query中示例值："0"

示例值:

limit

必需

请求列表的长度，0<limit<=10，请求query中示例值："0"="" <="" md-td=""></limit<=10，请求query中>

示例值:

lang

必需

请求OKR的语言版本（比如@的人名），lang=en_us/zh_cn，请求 Query中示例值："zh_cn" 默认值：zh_cn

示例值:

zh_cn

period_ids

array[string]

可选

period_id列表，最多10个示例值：["6951461264858777132"] 数据校验规则：最大长度：10

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

返回响应

🟢200200 Success

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

total

integer

OKR周期总数

必需

okr_list

array [object {5}]

OKR 列表

必需

修改于 2022-02-14 07:52:32

批量获取OKR

创建 OKR 进展记录