Skip to content

Create a saved view (config validated against live fields)

POST
/api/v1/workspaces/{ws}/databases/{db}/views
db
required
string
Media typeapplication/json
object
name
required
string
>= 1 characters <= 100 characters
type
required
string
Allowed values: table board calendar gallery list feed timeline form
config
object
filters
Any of:
object
field
required
string
>= 1 characters
op
required
string
Allowed values: eq neq contains gt gte lt lte before after within has has_none is_empty not_empty
value
sorts
Array<object>
default: <= 3 items
object
field
required
string
>= 1 characters
direction
string
default: asc
Allowed values: asc desc
hidden_field_ids
Array<string>
default:
group_by_field_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
card_field_ids
Array<string>
default:
card_size
string
Allowed values: small medium large
date_field_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
start_date_field_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
end_date_field_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
form
object
title
string
<= 200 characters
description
string
<= 2000 characters
submit_text
string
<= 50 characters
fields
Array<object>
default:
object
field_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
required
boolean
label
string
<= 100 characters
help
string
<= 500 characters
public_token
string
<= 64 characters
column_widths
object
key
additional properties
integer
>= 40 <= 1200