---
title: ObjectDefinition
slug: data-platform/connect-platform/node-sdk-api-reference-zaius-interfaces-objectdefinition
docTags: 
createdAt: 2026-08-05T20:06:34.959Z
---

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

# ObjectDefinition

The Zaius Object definition payload for schema APIs.
See [V3 Schema API](docId\:kBYwjpcJOd6Xu7iayinsB)
for details.

## Index

### Properties

- [alias](docId\:BTc-4lFtFEuRGxeCsjnk0)
- [display\\\_name](docId\:BTc-4lFtFEuRGxeCsjnk0)
- [fields](docId\:BTc-4lFtFEuRGxeCsjnk0)
- [name](docId\:BTc-4lFtFEuRGxeCsjnk0)
- [relations](docId\:BTc-4lFtFEuRGxeCsjnk0)

## Properties

### alias?

:::BlockQuote
`string`
:::

An alias for the object that can be used during ingest. Should be the singular form of the name.
Must be unique across all object names and aliases within the schema.
Will be automatically derived if not specified.

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

### display\_name

:::BlockQuote
`string`
:::

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

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

### fields

:::hint{type="info"}
[`` `FieldDefinition` ``](docId\:BTc-4lFtFEuRGxeCsjnk0)\[]
:::

Initial list of field definitions. Must at least contain a primary key field.

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

### name

:::BlockQuote
`string`
:::

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

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

### relations?

:::hint{type="info"}
[`` `RelationDefinition` ``](docId\:jbgHmuqDNXi2vUDMY8Ifm)\[]
:::

Initial list of relation definitions, if any.

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