---
title: FieldDefinition
slug: data-platform/connect-platform/node-sdk-api-reference-odp-interfaces-fielddefinition
docTags: 
createdAt: 2026-08-05T20:06:33.107Z
---

[ODP Node SDK](docId\:gxEU_0AA37IEZJK-uoVcT)

***

[ODP Node SDK](docId\:gxEU_0AA37IEZJK-uoVcT) / [ODP](docId\:R8vto_M9Wlz5ke8bcr-Ht) / FieldDefinition

# Interface: FieldDefinition

Defined in: [src/Api/Types/Schema.ts:6](https://github.com/ZaiusInc/node-sdk/blob/8c86908a179d8d1a3a54466e27e16762587be133/src/Api/Types/Schema.ts#L6)

The ODP Field definition payload for schema APIs.
See [V3 Schema API](docId\:OUytdJqc-K8-05eF0FQmP)
for details.

## Properties

### description?

:::BlockQuote
`optional` **description**: `string`
:::

Defined in: [src/Api/Types/Schema.ts:24](https://github.com/ZaiusInc/node-sdk/blob/8c86908a179d8d1a3a54466e27e16762587be133/src/Api/Types/Schema.ts#L24)

Description of the field and how it will be referenced in the ODP UI.
While optional, it's use is strongly encouraged.

***

### display\_name

:::BlockQuote
**display\_name**: `string`
:::

Defined in: [src/Api/Types/Schema.ts:19](https://github.com/ZaiusInc/node-sdk/blob/8c86908a179d8d1a3a54466e27e16762587be133/src/Api/Types/Schema.ts#L19)

The user-friendly name used within ODP. Must be unique across all display names within the object.

***

### name

:::BlockQuote
**name**: `string`
:::

Defined in: [src/Api/Types/Schema.ts:11](https://github.com/ZaiusInc/node-sdk/blob/8c86908a179d8d1a3a54466e27e16762587be133/src/Api/Types/Schema.ts#L11)

The name of the field. Lower snake case, alphanumeric, must start with an alpha character.
Must be unique across all field names within the object.

***

### primary?

:::BlockQuote
`optional` **primary**: `boolean`
:::

Defined in: [src/Api/Types/Schema.ts:29](https://github.com/ZaiusInc/node-sdk/blob/8c86908a179d8d1a3a54466e27e16762587be133/src/Api/Types/Schema.ts#L29)

Used when creating new objects to denote this field should be used as the primary key for the object.
Should be undefined or false for all other fields.

***

### type

:::BlockQuote
**type**: `"string"` | `"number"` | `"boolean"` | `"timestamp"` | `"vector"`
:::

Defined in: [src/Api/Types/Schema.ts:15](https://github.com/ZaiusInc/node-sdk/blob/8c86908a179d8d1a3a54466e27e16762587be133/src/Api/Types/Schema.ts#L15)

The type of the field: `string`, `number`, `timestamp`, `boolean` or `vector`.