v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB
Object fields

Create object field

Creates a column on an object. Requires a USER API key with ADMIN or OWNER role.

post/public/v1/objects/{name}/fields

Path parameters

namestring required
Example:deals

Request body

namestring required
metadataobject
record_type_idinteger
recordTypeIdinteger

Example request

{
  "name": "example",
  "type": "string",
  "record_type_id": 1,
  "recordTypeId": 1
}

Response

Created field

oktrue required

Example response

{
  "ok": true,
  "data": {
    "id": 1,
    "name": "example",
    "key": "example",
    "type": "example",
    "created_at": "example",
    "updated_at": "example",
    "format": "example",
    "mode": "singleSelect",
    "timezone": "example",
    "decimals": 1,
    "currency": "example",
    "min": 1,
    "max": 1,
    "time_format": "example",
    "allowed_file_types": [
      "example"
    ],
    "max_file_size": 1,
    "related_table_id": 1,
    "related_record_type_ids": [
      1
    ],
    "display_field_id": 1,
    "relation_mode": "example",
    "options": [
      {
        "id": 1,
        "name": "example",
        "color": "example",
        "order": 1,
        "created_at": "example",
        "updated_at": "example"
      }
    ],
    "output_type": "example"
  }
}