Skip to main content
GET
Preview a column type change

Authorizations

X-API-Key
string
header
required

Path Parameters

table_id
string<uuid>
required
column_id
string<uuid>
required

Query Parameters

column_type
enum<string>
required

The type the column would change to.

Available options:
text,
paragraph,
url,
email,
image_url,
person,
select,
number,
decimal,
currency,
checkbox,
date,
multi_select,
list,
object

Response

Successful Response

What changing a column's type would do to the values already in it.

Asking changes nothing. When the type does change, every value the new type can read is converted into it; cleared_count is the rest, which are left blank, so it is the number a person confirms before the change is made.

cleared_count
integer
required

Of those, how many the new type cannot hold and would be cleared.

column_type
enum<string>
required

The type the preview is for.

Available options:
text,
paragraph,
url,
email,
image_url,
person,
select,
number,
decimal,
currency,
checkbox,
date,
multi_select,
list,
object
value_count
integer
required

Cells in the column that hold a value today.