跳到主要内容

v1 API 获取单个表单视图

API 使用者,可以通过本接口,获取指定表单下某个视图的详细信息

功能免费版专业版/专业增强版企业基础版企业协作版企业高级版
获取单个表单视图✔️✔️✔️

认证方式

V1 Basic 认证方式

headers 设置

需要在请求中设置如下 headers

  • Content-Type: application/json
  • Accept: application/json
  • Authorization: 放入上一步骤生成的 CODE

接口说明

  • API 使用者可以获取自己创建或有访问权限的共享表单下的视图。
  • VIEW_TOKEN 可以从获取表单视图列表接口取得。

接口描述

Request

GET https://jinshuju.net/api/v1/forms/FORM_TOKEN/views/VIEW_TOKEN
参数名称是否必须类型说明
FORM_TOKENString表单 Token(URL 路径参数)
VIEW_TOKENString视图 Token(URL 路径参数)

Response

{
"token": "vA1b2C",
"name": "全部数据",
"view_type": "grid",
"position": 0,
"predefined": true,
"prefer_columns": ["serial_number", "field_1", "field_2"],
"sort": [
{ "api_code": "serial_number", "order": "desc" }
],
"filter": [
{ "field": "field_3", "operator": "eq", "value": "待跟进" }
],
"created_at": "2026-05-26T02:00:00.000Z",
"updated_at": "2026-05-26T02:00:00.000Z"
}
参数名称是否必须类型说明
tokenString视图 Token
nameString视图名称
view_typeString视图类型:grid / kanban / stats
positionNumber视图排序位置
predefinedBoolean是否为系统预设视图
prefer_columnsArray(String)视图展示的字段 api_code 列表;为空时表示展示表单可推送字段
sortArray排序规则数组
sort[].api_codeString排序字段的 api_code,可包含系统字段如 serial_number
sort[].orderString排序方向:asc / desc
filterArray视图筛选条件数组。无筛选条件时返回空数组
filter[].fieldString筛选字段的 api_code
filter[].operatorString筛选操作符
filter[].value取决于 operator筛选值;null / not_null 不返回该字段
created_atDateTime视图创建时间
updated_atDateTime视图最后更新时间

注意:数据中的日期时间,使用的是 UTC 时间(例如:"2026-05-26T02:00:00.000Z"),接受者需要自行转换为自己所需要的时区(例如北京时间)。

状态码

状态码说明
200获取成功
401未认证
402当前套餐不支持 V1 API
404表单或视图不存在,或无权访问

示例代码

HTTP

GET https://jinshuju.net/api/v1/forms/$FORM_TOKEN/views/$VIEW_TOKEN

Content-Type: application/json
Accept: application/json
Authorization: Basic BASE_64_ENCODED_CREDENTIALS

Python

import requests

api_key = 'YOUR_API_KEY'
api_secret = 'YOUR_API_SECRET'
form_token = 'YOUR_FORM_TOKEN'
view_token = 'YOUR_VIEW_TOKEN'

response = requests.get(
f'https://jinshuju.net/api/v1/forms/{form_token}/views/{view_token}',
auth=(api_key, api_secret)
)

print(response.text)