---
title: Fields schema overview
slug: data-platform/api/fields-schema-overview
docTags: 
createdAt: 2026-06-24T13:31:23.000Z
---

```json
{
  "name": "field_name",
  "type": "number",
  "auto": true,
  "display_name": "Display Name",
  "public_read": false,
  "description": "Description of field",
  "created_by": "zaius",
  "primary_key": true
}
```

| property      | description                                                                                    |
| ------------- | ---------------------------------------------------------------------------------------------- |
| name          | Name of the field.                                                                             |
| type          | Field data type. Options are `number`, `timestamp`, `text`, `boolean`.                         |
| auto          | (Read-only) Marks the field as one that is auto-populated by Optimizely Data Platform (ODP).   |
| display\_name | The user-friendly name used in ODP.                                                            |
| public\_read  | (Optional) Enable access with the public API key. The default value is `false`.                |
| description   | Description of the field.                                                                      |
| created\_by   | (Read-only) Specifies what or who created the field. Current values are `zaius` and `account`. |
| primary\_key  | Marks the field as identifying for the containing object. Only allowed during object creation. |