合同列表

接口说明

仅返回当前 key 创建的合同。

请求地址：/open/v1/contracts

请求方式：GET

在线调试

请求参数

每个请求须携带请求头 X-Api-Key。

参数名称	数据类型	必须	说明
status	string	否	合同状态： signing 进行中 completed 已完成 withdrawn 已撤回 refused 已拒签 voided 已作废 expired 已过期
page	number	否	页码，从 1 开始，默认 1
pageSize	number	否	每页条数，默认 20，最大 100

响应参数

参数名称	数据类型	必须	说明
code	number	是	0 表示成功
message	string	是	说明
data	object	是	业务数据
total	number	是	总条数
list	array	是	合同列表
contractId	string	是	合同 ID
contractName	string	是	合同名称
status	string	是	合同状态
deadline	string	是	签署截止时间，yyyy-MM-dd HH:mm:ss
createdAt	string	是	创建时间，yyyy-MM-dd HH:mm:ss
signUrl	string	否	微信小程序签署引导短链。仅当 status 为 signing 且链接尚未失效时返回
h5SignUrl	string	否	浏览器 H5 签署链接。返回条件同 signUrl

响应示例

{
  "code": 0,
  "message": "ok",
  "data": {
    "total": 1,
    "list": [
      {
        "contractId": "ct_20001",
        "contractName": "采购合同",
        "status": "signing",
        "deadline": "2026-11-20 18:00:00",
        "createdAt": "2026-10-27 11:00:00",
        "signUrl": "https://h5.xwkc.com/r8k2mQ",
        "h5SignUrl": "https://m.xwkc.com/#/ePackage/pages/contractDetail/index?taskId=ct_20001&sceneCon=personShare"
      }
    ]
  }
}