apiVersion

• Type: string | ((params: CallbackParams & { childOptions: ChildResolverOptions }) => string)
• Optional: Yes

The apiVersion property allows you to specify the Sanity API version for a specific list item.

Standard Usage

JSON

{
  schemaType: 'author',
  apiVersion: '2025-02-19',
}

Helpers

helpers.listing('author', {
  apiVersion: '2025-02-19',
});

Dynamic API Version (Callback)

You can specify the apiVersion dynamically using a callback function:

JSON

{
  schemaType: 'author',
  apiVersion: ({ workspace }) => workspace === 'production' ? '2026-06-19' : '2025-02-19',
}

Helpers

helpers.listing('author', {
  apiVersion: ({ workspace }) => (workspace === 'production' ? '2026-06-19' : '2025-02-19'),
});