乐享知识库接口文档

# 获取自定义属性列表

请求URL

GET https://lxapi.lexiangla.com/cgi-bin/v1/kb/properties

请求头

参数 是否必须 说明
Authorization 是 接口调用凭证 access_token
值格式："Bearer access_token"
示例值："Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS"

其他说明

事项 说明
权限要求 自定义属性管理
授权范围 AppKey绑定团队时，不支持传source_type=company；若source_type=kb_space，入参source_id知识库需在授权的团队下
频率限制 3000次/分钟

参数说明

参数 是否必须 说明
source_type 是 返回自定义属性列表的来源
company : 公司的自定义属性，kb_space : 指定知识库的自定义属性
source_id 否 当source_type=company，不用传值；当source_type=kb_space时，需传入对应的知识库ID
limit 否 限制个数，1～100 以内的整数
page_token 否 分页游标，根据上一页返回的page_token传入

响应

200 Ok 状态码


{
  "data": [
    {
      "type": "property",
      "id": "9dbbc33926204d19907396636dcff64e",
      "attributes": {
        "name": "文本属性",
        "created_at": "2025-10-16 22:01:59",
        "updated_at": "2025-10-16 22:01:59",
        "property_type": "text"
      },
      "relationships": {
        "owner": {
          "data": {
            "type": "staff",
            "id": "LX001"
          }
        }
      }
    },
    {
      "type": "property",
      "id": "08d1525397e34ae9a570852367fd8491",
      "attributes": {
        "name": "多选",
        "created_at": "2025-10-16 20:41:37",
        "updated_at": "2025-10-17 18:36:56",
        "property_type": "select"
      },
      "relationships": {
        "owner": {
          "data": {
            "type": "staff",
            "id": "LX001"
          }
        }
      }
    },
    {
      "type": "property",
      "id": "54bd7706688f4daab5e926f0b3869797",
      "attributes": {
        "name": "单选",
        "created_at": "2025-10-16 11:10:30",
        "updated_at": "2025-10-16 20:41:13",
        "property_type": "select"
      },
      "relationships": {
        "owner": {
          "data": {
            "type": "staff",
            "id": "LX001"
          }
        }
      }
    },
    {
      "type": "property",
      "id": "9026e292ba27405c8e22c2bf7a1828ff",
      "attributes": {
        "name": "分类",
        "created_at": "2025-10-16 10:48:51",
        "updated_at": "2025-10-17 15:18:25",
        "property_type": "category"
      },
      "relationships": {
        "owner": {
          "data": {
            "type": "staff",
            "id": "LX001"
          }
        }
      }
    }
  ],
  "included": [
    {
      "type": "staff",
      "id": "LX001",
      "attributes": {
        "name": "LX001",
        "english_name": "别名",
        "organization": "开发组"
      }
    }
  ],
  "meta": {
    "page_token": "WyIyMDI1LTA3LTE0VDEwOjM2OjI1KzA4OjAwIiw2MDRd"
  }
}

参数说明

参数 说明
name 属性名称
property_type 类型
text表示文本类型;
select表示选项类型;
category表示分类类型;
created_at 创建时间
updated_at 更新时间
relationships.owner 属性创建者，可根据 id 在 included 中查找

← 获取自定义属性详情 →