契约锁 API
  1. 合同管理
契约锁 API
  • 平台简介
    • 平台简介
  • 新手指南
    • 接入流程
    • 名称解释
    • 接入示例
  • API协议
    • API协议
  • API文档
    • 合同管理
      • 合同管理-创建合同草稿
        POST
      • 合同管理-用文件添加合同文档
        POST
      • 合同管理-多文件添加合同文档
        POST
      • 合同管理-用模板添加合同文档
        POST
      • 合同管理-发起合同
        POST
      • 合同管理-抄送合同
        POST
      • 合同管理-修改签署方
        POST
      • 合同管理-添加签署方
        POST
      • 合同管理-浏览页面
        GET
      • 合同管理-合同详情
        GET
      • 合同管理-获取合同列表
        GET
      • 合同管理-下载合同与附属文件
        GET
      • 合同管理-下载合同文档
        GET
      • 合同管理-强制结束合同
        POST
      • 合同管理-上传强制结束附件
        POST
      • 合同管理-合同文档添加水印
        POST
      • 合同管理-合同延期
        POST
      • 合同管理-获取合同操作记录
        GET
      • 合同管理-获取合同与附属文件下载链接
        GET
    • 签署服务
      • 签署服务-公章签署
      • 签署服务-签署法人章
      • 签署服务-审批
      • 签署服务-合同催签
      • 签署服务-签署页面
      • 签署服务-预签署页面
      • 签署服务-获取短链接
      • 签署服务-撤回/作废合同
      • 签署服务-自定义文件作废合同
      • 签署服务-自定义模板文件作废合同
      • 签署服务-签署作废合同
      • 签署服务-签署个人签名
    • 组织架构
      • 组织架构-子公司列表
      • 组织架构-发送子公司邀请
      • 组织架构-移除子公司
      • 组织架构-对接方信息
      • 组织架构-公司详情
      • 组织架构-获取企业信息变更链接
      • 组织架构-员工列表
      • 组织架构-添加员工
      • 组织架构-更新员工
      • 组织架构-员工详情
      • 组织架构-管理员工角色
      • 组织架构-移除员工
    • 印章管理
      • 印章管理-印章列表
      • 印章管理-印章图片
      • 印章管理-创建印章
      • 印章管理-印章详情
      • 印章管理-编辑印章
      • 印章管理-创建图片印章
      • 印章管理-管理印章状态
      • 印章管理-删除印章
      • 印章管理-公司印章
    • 模板管理
      • 模板管理-模板列表
      • 模板管理-模板详情
      • 模板管理-模版预览页面
      • 模板管理-创建Word模板
      • 模板管理-编辑模板
      • 模板管理-管理模板状态
      • 模板管理-下载模板
      • 模板管理-删除模板
    • 业务分类
      • 业务分类-业务分类列表
      • 业务分类-业务分类详情
    • 个人认证
      • 个人认证-获取个人认证链接
      • 个人认证-查询个人认证状态
    • 企业认证
      • 企业认证-获取企业认证链接PC
      • 企业认证-获取企业认证链接H5
      • 企业认证-获取企业认证链接-带营业执照PC
      • 企业认证-获取企业认证链接-带营业执照H5
      • 企业认证-查询认证结果
    • 外部客户
      • 外部客户-新增外部客户
    • 授权管理
      • 授权管理-单点登录模块授权页面
      • 授权管理-个人签名授权页面
      • 授权管理-取消个人签名授权
      • 授权管理-查询个人静默签授权记录
    • 辅助工具
      • 辅助工具-文件验签
    • 信息校验
      • 信息校验-个人身份校验
      • 信息校验-企业身份校验
  • 单点登录集成
    • 集成流程说明
    • 单点登录
    • 单点登出
    • CAS验证接口规范
  • JS SDK文档
    • JS SDK简介
    • 集成方式说明
    • 对接方服务端接口说明
  • 公告
    • 关于开发平台控制台的说明
  • 小程序插件
    • 插件简介
    • 插件集成说明
    • 生成合同签署令牌
    • 生成个人认证令牌
    • 生成企业认证令牌
    • 生成企业认证令牌(带营业执照)
    • 插件更新记录
  • 常见问题
    • 认证问题
    • 配置问题
    • 接口问题
    • 其他问题
  1. 合同管理

合同管理-获取合同列表

GET
/v2/contract/list
调用此接口获取平台合同列表,支持子公司合同列表的查询。

请求参数

Query 参数
status
string 
可选
合同状态(DRAFT(草稿),RECALLED(撤回),SIGNING(签约中),REJECTED(已退回),COMPLETE(已完成),EXPIRED(已过期),FILLING(拟定中),INVALIDING(作废中),INVALIDED(已作废),FORCE_END(强制结束)
selectOffset
integer 
可选
查询开始的位置(从0开始)
selectLimit
integer 
可选
查询条数限制(默认1000)
tenantName
string 
子公司名称
可选
createTimeOrder
string 
可选
排序(ASC:时间升序 DESC:时间降序)
categoryId
number 
业务分类ID
可选
categoryName
string 
业务分类名称
可选
publishTimeStart
string 
可选
合同发起的开始时间,格式为yyyy-MM-dd HH:mm:ss,该字段为空时默认取六个月前的时间节点
publishTimeEnd
string 
可选
合同发起的结束时间,格式为yyyy-MM-dd HH:mm:ss,该字段为空时默认取当前时间节点
signatoryType
string 
可选
签署方类型,默认SPONSOR,(SPONSOR:发起方,RECEIVER:接收方,ALL:全部)
Header 参数
x-qys-open-accesstoken
string 
可选
默认值:
{{x-qys-open-accesstoken}}
x-qys-open-timestamp
string 
可选
默认值:
{{x-qys-open-timestamp}}
x-qys-open-nonce
string 
可选
默认值:
{{x-qys-open-nonce}}
x-qys-open-signature
string 
可选
默认值:
{{x-qys-open-signature}}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://openapi.qiyuesuo.com/v2/contract/list' \
--header 'x-qys-open-accesstoken: {{x-qys-open-accesstoken}}' \
--header 'x-qys-open-timestamp: {{x-qys-open-timestamp}}' \
--header 'x-qys-open-nonce: {{x-qys-open-nonce}}' \
--header 'x-qys-open-signature: {{x-qys-open-signature}}'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
message
string 
必需
result
object 
必需
totalCount
string 
必需
list
array[object (ContractBeanResponse) {9}] 
可选
示例
{
    "result": {
        "list": [
            {
                "id": "3053227767890968697",
                "subject": "接口发起",
                "description": "合同描述",
                "sn": "接口发起",
                "tenantName": "思晨教育",
                "ordinal": true,
                "category": {
                    "id": "3053202902198805409",
                    "name": "自动化测试-勿动zxs"
                },
                "status": "SIGNING",
                "expireTime": "2023-03-19 00:00:00",
                "publishTime": "2023-01-18 15:17:08"
            },
            {
                "id": "3053227669467430994",
                "subject": "接口发起",
                "description": "合同描述",
                "sn": "接口发起",
                "tenantName": "思晨教育",
                "ordinal": true,
                "category": {
                    "id": "3053202902198805409",
                    "name": "自动化测试-勿动zxs"
                },
                "status": "DRAFT",
                "expireTime": "2023-02-17 15:16:43"
            },
            {
                "id": "3053227552081445871",
                "subject": "接口发起",
                "description": "合同描述",
                "sn": "接口发起",
                "tenantName": "思晨教育",
                "ordinal": true,
                "category": {
                    "id": "3053202902198805409",
                    "name": "自动化测试-勿动zxs"
                },
                "status": "FORCE_END",
                "expireTime": "2023-03-19 00:00:00",
                "publishTime": "2023-01-18 15:16:16"
            },
            {
                "id": "3053227470749696936",
                "subject": "接口发起",
                "description": "合同描述",
                "sn": "接口发起",
                "tenantName": "思晨教育",
                "ordinal": true,
                "category": {
                    "id": "3053202902198805409",
                    "name": "自动化测试-勿动zxs"
                },
                "status": "FORCE_END",
                "expireTime": "2023-03-19 00:00:00",
                "publishTime": "2023-01-18 15:15:57"
            },
            {
                "id": "3053226614729999114",
                "subject": "接口发起",
                "description": "合同描述",
                "sn": "接口发起",
                "tenantName": "思晨教育",
                "ordinal": true,
                "category": {
                    "id": "3053202902198805409",
                    "name": "自动化测试-勿动zxs"
                },
                "status": "FORCE_END",
                "expireTime": "2023-03-19 00:00:00",
                "publishTime": "2023-01-18 15:12:33"
            },
            {
                "id": "3053226147249652420",
                "subject": "接口发起",
                "description": "合同描述",
                "sn": "接口发起",
                "tenantName": "思晨教育",
                "ordinal": true,
                "category": {
                    "id": "3053202902198805409",
                    "name": "自动化测试-勿动zxs"
                },
                "status": "FORCE_END",
                "expireTime": "2023-03-19 00:00:00",
                "publishTime": "2023-01-18 15:10:41"
            },
            {
                "id": "3053225984628097662",
                "subject": "接口发起",
                "description": "合同描述",
                "sn": "接口发起",
                "tenantName": "思晨教育",
                "ordinal": true,
                "category": {
                    "id": "3053202902198805409",
                    "name": "自动化测试-勿动zxs"
                },
                "status": "FORCE_END",
                "expireTime": "2023-03-19 00:00:00",
                "publishTime": "2023-01-18 15:10:03"
            },
            {
                "id": "3053225547015389715",
                "subject": "接口发起1674025696230",
                "description": "合同描述",
                "sn": "接口发起",
                "tenantName": "思晨教育",
                "ordinal": true,
                "category": {
                    "id": "3052790533433852898",
                    "name": "yyb"
                },
                "status": "RECALLED",
                "expireTime": "2023-02-17 15:08:17",
                "publishTime": "2023-01-18 15:08:18"
            },
            {
                "id": "3053225507760898391",
                "subject": "接口发起1674025686997",
                "description": "合同描述",
                "sn": "接口发起",
                "tenantName": "思晨教育",
                "ordinal": true,
                "category": {
                    "id": "3052790533433852898",
                    "name": "yyb"
                },
                "status": "INVALIDING",
                "expireTime": "2023-02-17 15:08:15",
                "publishTime": "2023-01-18 15:08:08"
            },
            {
                "id": "3053225373341843697",
                "subject": "接口发起1674025654821",
                "description": "合同描述",
                "sn": "接口发起",
                "tenantName": "思
上一页
合同管理-合同详情
下一页
合同管理-下载合同与附属文件
Built with