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

[ODP Node SDK](docId\:gxEU_0AA37IEZJK-uoVcT) / [Zaius](docId\:Ymt8R5EsKRYBHwqG3pJkL) / FieldDefinition

# FieldDefinition

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

## Index

### Properties

- [description](docId\:BTc-4lFtFEuRGxeCsjnk0)
- [display\\\_name](docId\:BTc-4lFtFEuRGxeCsjnk0)
- [name](docId\:BTc-4lFtFEuRGxeCsjnk0)
- [primary](docId\:BTc-4lFtFEuRGxeCsjnk0)
- [type](docId\:BTc-4lFtFEuRGxeCsjnk0)

## Properties

### description?

:::BlockQuote
`string`
:::

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

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

### display\_name

:::BlockQuote
`string`
:::

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

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

### name

:::BlockQuote
`string`
:::

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.

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

### primary?

:::BlockQuote
`boolean`
:::

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.

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

### type

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

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

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