跳到主要内容

v1 API 获取单个表单视图

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

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

认证方式​

V1 Bearer 认证方式

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_TOKEN是String表单 Token(URL 路径参数)
VIEW_TOKEN是String视图 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"
}
参数名称是否必须类型说明
token是String视图 Token
name是String视图名称
view_type是String视图类型:grid / kanban / stats / form(表单视图)
position是Integer视图排序位置
predefined是Boolean是否为系统预设视图
visibility是String可见性:cooperators(协作者可见)/ personal(仅创建者可见)
view_scope是String视图归属:user / form。form 视图不可删除,也不可切换可见性
prefer_columns是Array(String)视图展示的字段 api_code 列表;为空时表示展示表单可推送字段
sorted_columns是Array(Object)列的显示顺序,按 position 升序
sorted_columns[].api_code是String字段的 api_code
sorted_columns[].position是Integer列位置,从 1 开始
kanban_group_by_api_code是String / null看板视图分组字段的 api_code
kanban_card_title_api_code是String / null看板卡片标题字段的 api_code;未设置时按 prefer_columns 推算
kanban_group_order是Array(String)看板分组的显示顺序,元素为分组选项的 api_code;__unset__ 表示未分组
kanban_hidden_groups是Array(String)隐藏的看板分组,取值同 kanban_group_order
grid_frozen_boundary_api_code是String / null表格视图中冻结列边界处字段的 api_code
sort是Array(Object)排序规则数组
sort[].api_code是String排序字段的 api_code,可包含系统字段如 serial_number
sort[].order是String排序方向:asc / desc
filter是Array(FormViewFilterCondition)视图筛选条件数组。无筛选条件时返回空数组
created_at是DateTime视图创建时间
updated_at是DateTime视图最后更新时间
title否String / null填写页标题(仅表单视图返回)
description否String / null填写页描述(仅表单视图返回)
published否Boolean是否已发布,未发布时填写链接不可用(仅表单视图返回)
fill_url否String对外填写链接(仅表单视图返回)
fill_items否Array(FormViewFillItem)填写页上勾选的填写项,按填写页顺序(仅表单视图返回)

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

状态码​

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

数据类型​

FormViewFilterCondition​

参数名称是否必须类型说明
field是String筛选字段的 api_code
operator是String筛选操作符
value否Any筛选值;运算符为 null / not_null 时没有该字段

FormViewFillItem​

参数名称是否必须类型说明
api_code是String列的 api_code
label是String / null填写页上显示的标题,未单独设置时为列标题
notes是String / null填写页上显示的说明,未单独设置时为列说明
required是Boolean是否必填

示例代码​

HTTP​

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

Content-Type: application/json
Accept: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

Python​

import requests

access_token = 'YOUR_ACCESS_TOKEN'
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}',
headers={'Authorization': f'Bearer {access_token}'}
)

print(response.text)