View states

List

Returns the saved view states (column layout, sort, page size, view type and kanban keys) for the given entity, each carrying a server-built catalogue of its fields that says which of them can be filtered, sorted, grouped and batch updated. The call persists as well as reads: a scope with no stored state gets the default created and saved, and stale states are rebuilt; ticket view states belong to the calling User while every other entity's is shared workspace-wide, so saving one there overwrites it for everyone.

GET /api/{tenant:minlength(2)}/v{version:apiVersion}/view_states

Authorisation: Minimum role: USER

Request arguments

Name	Type	Source
entity	ENUM entity
optional_id	Int32

Request body example

Response

Status: 200 (OK)
Type: DTO_view_state[]

Wrapper: DTO_response_wrap

Other statuses: 400 (BadRequest), 403 (Forbidden)

Response body example

DTO_view_state

Name	Type	Description
name	String	Name of view
field_infos	DTO_view_state_field_info[]	Read only data
field_settings	DTO_view_state_field_setting[]	Configurable data per field
sort	DTO_view_state_sort	Sort
pagination	DTO_view_state_pagination	Pagination
view_type	ENUM view_type	View type
kanban	DTO_view_state_kanban	Kanban

DTO_view_state_field_info

Name	Type	Description
field_key	String	Field key
label	String	Label
data_type	ENUM field_data_type	Data type
filter	DTO_view_state_field_filter	Filter
group	DTO_view_state_field_group	Group
batch_update	DTO_view_state_field_batch	Batch update
sort	DTO_view_state_field_sort	Sort

DTO_view_state_field_filter

Name	Type	Description
allow	Boolean	Allow
type	ENUM filter_type	Type
usage_count	Int32	Usage count

DTO_view_state_field_group

Name	Type	ReadOnly	Description
allow	Boolean		Allow

DTO_view_state_field_batch

Name	Type	ReadOnly	Description
allow	Boolean		Allow

DTO_view_state_field_sort

Name	Type	ReadOnly	Description
allow	Boolean		Allow

DTO_view_state_field_setting

Name	Type	Description
field_key	String	Field key
column	DTO_view_state_field_column	Column
row	DTO_view_state_field_row	Row
kanban	DTO_view_state_field_kanban	Kanban
filter	DTO_view_state_field_setting_filter	Optional on save: an older client that doesn't know about filter visibility leaves it out, and the server then keeps it in step with the column instead of wiping it.

DTO_view_state_field_column

Name	Type	Description
width	Int32	Width
visible	Boolean	Visible
order	Int32	Order

DTO_view_state_field_row

Name	Type	ReadOnly	Description
upper_order	Int32		Upper order
lower_order	Int32		Lower order

DTO_view_state_field_kanban

Name	Type	ReadOnly	Description
card_position	Int32		Card position
hover_order	Int32		Hover order

DTO_view_state_field_setting_filter

Name	Type	ReadOnly	Description
visible	Boolean		Visible

DTO_view_state_sort

Name	Type	ReadOnly	Description
field_key	String		Field key
order	ENUM sort_order		Order

DTO_view_state_pagination

Name	Type	ReadOnly	Description
take	Int32		Take

DTO_view_state_kanban

Name	Type	Description
swimlane_key	String	Swimlane key
swimlane_order	String[]	Swimlane order
column_key	String	Column key
column_order	String[]	Column order

ENUM field_data_type

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	STRING	Text
2	MULTI_LINE_STRING	Text (multi-line)
3	DATE_TIME	Date and time
4	DATE_NO_TIME	Date
5	DOUBLE	Number (decimal)
6	INT	Number (int)
7	LONG	Number (long)
8	BOOL	On / Off
9	EMAIL	Text (email)
10	PHONE	Text (phone)
11	PICK_ONE	Pick one
12	PICK_MANY	Pick many
13	IMAGE	Image
14	RICH_TEXT	Text (rich editor)
15	FILES	Files
16	COLOR	Color
-1	INTERNAL_ENUM	INTERNAL_ENUM

ENUM filter_type

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	DEFAULT	Default
2	RANGE	Range

ENUM sort_order

Value	Name	Description
0	ASC	ASC
1	DESC	DESC

ENUM view_type

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	LIST	List
2	KANBAN	Kanban

Generated Aug 4, 2026 18:37