JSON Field

The JSON Field saves raw JSON to the database and provides the Admin Panel with a code editor styled interface. This is different from the Code Field which saves the value as a string in the database.

This field is using the `monaco-react` editor syntax highlighting.

To add a JSON Field, set the type to json in your Field Config:

1import type { Field } from 'payload'
2
3export const MyJSONField: Field = {
4  // ...
5  type: 'json', 
6}

Config Options

Option	Description
`name` *	To be used as the property name when stored and retrieved from the database. More
`label`	Text used as a field label in the Admin Panel or an object with keys for each language.
`unique`	Enforce that each entry in the Collection has a unique value for this field.
`index`	Build an index for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often.
`validate`	Provide a custom validation function that will be executed on both the Admin Panel and the backend. More
`jsonSchema`	Provide a JSON schema that will be used for validation. JSON schemas
`saveToJWT`	If this field is top-level and nested in a config supporting Authentication, include its data in the user JWT.
`hooks`	Provide Field Hooks to control logic for this field. More details.
`access`	Provide Field Access Control to denote what users can see and do with this field's data. More details.
`hidden`	Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin Panel.
`defaultValue`	Provide data to be used for this field's default value. More
`localized`	Enable localization for this field. Requires localization to be enabled in the Base config.
`required`	Require this field to have a value.
`admin`	Admin-specific configuration. More details.
`custom`	Extension point for adding custom data (e.g. for plugins)
`typescriptSchema`	Override field type generation with providing a JSON schema
`virtual`	Provide `true` to disable field in the database. See Virtual Fields

* An asterisk denotes that a property is required.

Admin Options

The customize the appearance and behavior of the JSON Field in the Admin Panel, you can use the admin option:

1import type { Field } from 'payload'
2
3export const MyJSONField: Field = {
4  // ...
5  admin: { 
6    // ...
7  },
8}

The JSON Field inherits all of the default options from the base Field Admin Config, plus the following additional options:

Option	Description
`editorOptions`	Options that can be passed to the monaco editor, view the full list.

Example

collections/ExampleCollection.ts

1import type { CollectionConfig } from 'payload'
2
3export const ExampleCollection: CollectionConfig = {
4  slug: 'example-collection',
5  fields: [
6    {
7      name: 'customerJSON', // required
8      type: 'json', // required
9      required: true,
10    },
11  ],
12}

JSON Schema Validation

Payload JSON fields fully support the JSON schema standard. By providing a schema in your field config, the editor will be guided in the admin UI, getting typeahead for properties and their formats automatically. When the document is saved, the default validation will prevent saving any invalid data in the field according to the schema in your config.

If you only provide a URL to a schema, Payload will fetch the desired schema if it is publicly available. If not, it is recommended to add the schema directly to your config or import it from another file so that it can be implemented consistently in your project.

Local JSON Schema

collections/ExampleCollection.ts

1import type { CollectionConfig } from 'payload'
2
3export const ExampleCollection: CollectionConfig = {
slug: 'example-collection',
fields: [
  {
    name: 'customerJSON', // required
    type: 'json', // required
    jsonSchema: {
      uri: 'a://b/foo.json', // required
      fileMatch: ['a://b/foo.json'], // required
      schema: {
        type: 'object',
        properties: {
          foo: {
            enum: ['bar', 'foobar'],
          }
        },
      },
    },
21
  },
],
24}
25// {"foo": "bar"} or {"foo": "foobar"} - ok
26// Attempting to create {"foo": "not-bar"} will throw an error

Remote JSON Schema

collections/ExampleCollection.ts

1import type { CollectionConfig } from 'payload'
2
3export const ExampleCollection: CollectionConfig = {
4  slug: 'example-collection',
5  fields: [
6    {
7      name: 'customerJSON', // required
8      type: 'json', // required
9      jsonSchema: {
10        uri: 'https://example.com/customer.schema.json', // required
11        fileMatch: ['https://example.com/customer.schema.json'], // required
12      },
13    },
14  ],
15}
16// If 'https://example.com/customer.schema.json' has a JSON schema
17// {"foo": "bar"} or {"foo": "foobar"} - ok
18// Attempting to create {"foo": "not-bar"} will throw an error

1import type React from 'react'
2import { JSONField } from '@payloadcms/ui'
3import type { JSONFieldServerComponent } from 'payload'
4
5export const CustomJSONFieldServer: JSONFieldServerComponent = ({
6  clientField,
7  path,
8  schemaPath,
9  permissions,
10}) => {
11  return (
12    <JSONField
13      field={clientField}
14      path={path}
15      schemaPath={schemaPath}
16      permissions={permissions}
17    />
18  )
19}

Client Component

1'use client'
2import React from 'react'
3import { JSONField } from '@payloadcms/ui'
4import type { JSONFieldClientComponent } from 'payload'
5
6export const CustomJSONFieldClient: JSONFieldClientComponent = (props) => {
7  return <JSONField {...props} />
8}

Label

Server Component

1import React from 'react'
2import { FieldLabel } from '@payloadcms/ui'
3import type { JSONFieldLabelServerComponent } from 'payload'
4
5export const CustomJSONFieldLabelServer: JSONFieldLabelServerComponent = ({
6  clientField,
7  path,
8}) => {
9  return (
10    <FieldLabel
11      label={clientField?.label || clientField?.name}
12      path={path}
13      required={clientField?.required}
14    />
15  )
16}

Client Component

1'use client'
2import React from 'react'
3import { FieldLabel } from '@payloadcms/ui'
4import type { JSONFieldLabelClientComponent } from 'payload'
5
6export const CustomJSONFieldLabelClient: JSONFieldLabelClientComponent = ({
7  field,
8  path,
9}) => {
10  return (
11    <FieldLabel
12      label={field?.label || field?.name}
13      path={path}
14      required={field?.required}
15    />
16  )
17}

See what others are building with Payload.

"Payload has transformed the way our clients manage content. It's an indispensable tool for any modern agency."

Deploy your entire stack in one place with Payload Cloud.

Microsoft chose Payload to tell the world about AI.

JSON Field

Config Options

Admin Options

Example

JSON Schema Validation

Local JSON Schema

Remote JSON Schema

Custom Components

Field

Server Component

Client Component

Label

Server Component

Client Component

Code Field