Skip to main content
POST
Create a view

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

The ID of the org

Body

table_id
string
required
Maximum string length: 128
kind
enum<string>
required
Available options:
table,
board,
calendar,
timeline,
list,
gallery
id
string

Client-generated id for the new view (enables optimistic creation). Encoded (view_…) or raw UUID. Rejected if already in use.

Maximum string length: 128
name
string
Required string length: 1 - 128
description
string
Maximum string length: 512
color
enum<string>

The name of the color to use in the UI

Available options:
red,
orange,
amber,
yellow,
lime,
green,
teal,
cyan,
sky,
blue,
indigo,
violet,
purple,
fuchsia,
pink,
rose,
neutral
icon

The emoji of a curated icon a user can pick for a table, view, field, or other entity

config
object
sort
object | null
filter
object

Response

200 - application/json
id
string
required
table_id
string
required
table_type
enum<string>
required
Available options:
custom,
contacts,
chats,
users
name
string | null
required
description
string | null
required
color
enum<string> | null
required

The name of the color to use in the UI

Available options:
red,
orange,
amber,
yellow,
lime,
green,
teal,
cyan,
sky,
blue,
indigo,
violet,
purple,
fuchsia,
pink,
rose,
neutral
icon
required

The emoji of a curated icon a user can pick for a table, view, field, or other entity

kind
enum<string>
required
Available options:
table,
board,
calendar,
timeline,
list,
gallery
config
object
required
sort
object | null
required
filter
object
required
position
integer
required
is_default
boolean
required
show_in_sidebar
boolean
required
archived
boolean
required
created_at
string<date-time> | null
required
updated_at
string<date-time> | null
required