获取用户的 OKR 列表

GET

https://open.feishu.cn/open-apis/okr/v1/users/{user_id}/okrs

根据用户的 id 获取 OKR 列表。

使用 tenant_access_token 需要额外申请权限

错误码

HTTP状态码	错误码	描述	排查建议
500	1009999	Unknown error. Please contact Feishu Assistant or your customer success manager.	内部错误，请联系飞书助手或您的客户成功经理
500	1009998	system exception	系统异常
400	1001001	Invalid parameters. Please check document and modify accordingly.	无效的参数，请对照文档检查输入的参数
400	1001002	No permission.	您无权访问该接口，请确认您的登录凭证
400	1001003	User not found.	用户不存在
400	1001004	OKR data not found.	对应ID的数据不存在

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

{
  "code": 0,
  "data": {
    "okr_list": [
      {
        "confirm_status": 4,
        "id": "7072252816005349396",
        "name": "2022 年 3 月",
        "objective_list": [
          {
            "aligned_objective_list": [],
            "aligning_objective_list": [],
            "content": "需求@刘三",
            "deadline": "1648656000000",
            "id": "7073360513731690515",
            "kr_list": [
              {
                "content": "1111@张三9",
                "deadline": "1648656000000",
                "id": "7073360471990140948",
                "kr_weight": 50,
                "mentioned_user_list": [
                  {
                    "open_id": "ou_a79faffdb6aee3618f0da4d42b192466",
                    "user_id": "6887399402823058952"
                  }
                ],
                "progress_rate": {
                  "percent": 60,
                  "status": "1"
                },
                "progress_rate_percent_last_updated_time": "1646907176099",
                "progress_rate_status_last_updated_time": "1646907176099",
                "progress_record_last_updated_time": "1646907586253",
                "progress_record_list": [
                  {
                    "id": "7073411057431199764"
                  }
                ],
                "progress_report_last_updated_time": "0",
                "score": 100,
                "score_last_updated_time": "1646907586244",
                "weight": 50
              }
            ],
            "mentioned_user_list": [
              {
                "open_id": "ou_ab08720df94e64045cc8c2b7694ef2a0",
                "user_id": "6886701186532001294"
              }
            ],
            "permission": 1,
            "progress_rate": {
              "percent": 30,
              "status": "0"
            },
            "progress_rate_percent_last_updated_time": "1646907261326",
            "progress_rate_status_last_updated_time": "1646907261326",
            "progress_record_last_updated_time": "1646907590448",
            "progress_record_list": [
              {
                "id": "7073360502990061587"
              }
            ],
            "progress_report": "红豆泥",
            "progress_report_last_updated_time": "1646907387911",
            "score": 100,
            "score_last_updated_time": "1646907590472",
            "weight": 40
          }
        ],
        "period_id": "7067724095781142548",
        "permission": 1
      }
    ],
    "total": 14
  },
  "msg": "success"
}

请求参数

Path 参数

user_id

string

目标用户id

必需

示例值:

ou-asdasdasdasdasd

Query 参数

user_id_type

string

必需

用户 ID 类型

示例值："open_id"

可选值有：

open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID
union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？
user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？
people_admin_id：以people_admin_id来识别用户
默认值：open_id

当值为 user_id，字段权限要求：

获取用户 user ID

offset

string

必需

请求列表的偏移，offset>=0

示例值："0"

limit

string

必需

列表长度，0-10

示例值："5"

lang

string

可选

请求OKR的语言版本（比如@的人名），lang=en_us/zh_cn

示例值："zh_cn"

默认值：zh_cn

period_ids

string

可选

period_id列表，最多10个

示例值：["6951461264858777132"]

数据校验规则：

最大长度：10

Header 参数

Authorization

string

必需

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

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

data

object

必需

okr_list

array [object {6}]

OKR 列表

必需

total

integer

OKR周期总数

必需

msg

string

错误描述

必需

获取OKR周期列表

批量获取OKR

获取用户的 OKR 列表

错误码#

请求参数

返回响应

错误码