# 查找可用于建码的模板

分页返回可用于建码的模板摘要（名称、template_id、project_id、category_id 等），只读，不修改模板。project_id=0 只查默认分区，分区先用 qrcodes/listCreateTargets 查询；选定模板后用 templates/getSchema 读取字段和版本。

## 请求

```text
POST https://open.cli.im/api/v2/rpc/templates/listEditable
```

| 项目 | 要求 |
|---|---|
| 最低权限 | 只读，见[权限档位](https://cli.im/open-api/openapi/v2/auth.md#org-policy) |
| 需要的 scope | `templates.read` |
| 组织 Key | 不能调用，返回 403 `credential_type_not_allowed`，见[历史组织 Key](https://cli.im/open-api/openapi/v2/auth.md#org-key) |

## 请求参数

请求体为 JSON。

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `project_id` | integer | 否 | 分区 ID，0 为默认分区（不代表全部分区）。可用的分区用 qrcodes/listCreateTargets 查询。默认 `0` |
| `page` | integer | 否 | 页码，从 1 开始。默认 `1`。最小 1 |
| `page_size` | integer | 否 | 每页条数。默认 `20`。范围 1–100 |
| `only_creatable` | boolean | 否 | 默认 false，只返回摘要。为 true 时逐个检查模板，只返回可以批量建码的模板，并附带版本和支持的操作，速度较慢。默认 `false` |

## 请求示例

示例里的 ID、幂等键等换成实际值。

```bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/templates/listEditable' \
  -H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "project_id": 0,
  "page": 1,
  "page_size": 20
}'
```

## 响应

成功时 HTTP 状态码为 200，顶层 `code` 为 `0`，结果在 `data` 里。失败时的返回见[错误码与调用额度](https://cli.im/open-api/openapi/v2/error-codes.md)和[业务错误码](https://cli.im/open-api/openapi/v2/error-catalog.md)。

| 字段 | 类型 | 一定返回 | 说明 |
|---|---|---|---|
| `data.items` | object[] | 是 | 模板摘要 |
| `data.items[].template_id` | string | 是 | 模板 ID |
| `data.items[].name` | string | 是 | 模板名称 |
| `data.items[].project_id` | string | 是 | 所在分区 ID |
| `data.items[].category_id` | integer | 是 | 所在目录 ID |
| `data.items[].coding` | string | 是 | 模板的短编号 |
| `data.items[].web_url` | string | 是 | 模板的扫码地址 |
| `data.items[].template_version` | string | 否 | 模板版本；only_creatable 为 true 时返回 |
| `data.items[].capabilities` | any | 否 | 模板支持的操作，结构同 templates/getSchema；only_creatable 为 true 时返回 |
| `data.page` | integer | 是 | 当前页码，从 1 开始 |
| `data.page_size` | integer | 是 | 每页条数 |
| `data.has_more` | boolean | 是 | 是否还有下一页。为 true 时即使当前页为空也应继续翻页 |

### 响应示例

```json
{
  "code": 0,
  "message": "ok",
  "data": {
    "items": [
      {
        "template_id": "6801234",
        "name": "设备档案",
        "project_id": "0",
        "category_id": 120045,
        "coding": "qTpl001",
        "web_url": "https://qr61.cn/oAbCdE/qTpl001"
      }
    ],
    "page": 1,
    "page_size": 20,
    "has_more": false
  }
}
```

## 常见错误

`PERMISSION_DENIED`。含义和处理方式见[业务错误码](https://cli.im/open-api/openapi/v2/error-catalog.md)。

---

本页由 [openapi.json](https://cli.im/open-api/openapi/v2/overview.md#%E6%8E%A5%E5%8F%A3%E8%A7%84%E8%8C%83-openapi-json) 生成。全部接口见[接口清单](https://cli.im/open-api/openapi/v2/api-index.md)。
