--- title: space fields description: Manage Space field definitions and values. canonical_url: https://orchestor.io/docs/en/space/cli/fields markdown_url: https://orchestor.io/docs/en/space/cli/fields.md contentType: reference --- # space fields `orc space fields` lists, creates, updates, and archives the field definitions attached to Space items. `orc space items fields` reads and writes field values on each document, sheet, file, and folder. Authentication and a selected Workspace are required. Creating, updating, and archiving field definitions requires `workspace:settings`. Writing values requires `files:write` for files and folders, or `doc:update` for documents and sheets. ## Usage ```bash title="terminal" orc space fields list --workspace YOUR_WORKSPACE_ID --format json ``` *List the field definitions in a Workspace.* ## Subcommands ### `list` Without `--project-id`, returns Workspace fields only. With it, also returns that project's fields, Workspace fields first and each scope ordered by position. Includes read-only system fields, which are never stored. ```bash title="terminal" orc space fields list [options] ``` #### Unique options ##### `--project-id` value Type: `string`. Optional. ```bash title="terminal" orc space fields list --project-id ``` ### `create` Creates a field from a `type`, `slug`, `title`, and the type's `config`. A `slug` cannot repeat within the same Workspace and project scope. ```bash title="terminal" orc space fields create [options] ``` #### Unique options ##### `--config` (required) Body field: config; (JSON object, e.g. '{"custom_id":"x"}') Type: `string`. Optional. ```bash title="terminal" orc space fields create --config ``` ##### `--is-required` Body field: is_required Type: `string`. Optional. ```bash title="terminal" orc space fields create --is-required ``` ##### `--position` Body field: position Type: `number`. Optional. ```bash title="terminal" orc space fields create --position ``` ##### `--project-id` Body field: project_id; (use "null" or "reset" to clear) Type: `string`. Optional. ```bash title="terminal" orc space fields create --project-id ``` ##### `--slug` (required) Body field: slug; max 128 chars Type: `string`. Optional. ```bash title="terminal" orc space fields create --slug ``` ##### `--title` (required) Body field: title; max 256 chars Type: `string`. Optional. ```bash title="terminal" orc space fields create --title ``` ##### `--type` (required) Body field: type; enum: text|long_text|number|checkbox|select|multi_select|date|member|url|timecode|time_range|segment_list|object Type: `string`. Optional. ```bash title="terminal" orc space fields create --type ``` ### `update` Updates a field definition. The type, `slug`, and scope cannot change. `config` is validated against the stored type, and existing values are kept. ```bash title="terminal" orc space fields update [options] ``` #### Unique options ##### `--config` Body field: config; (JSON object, e.g. '{"custom_id":"x"}') Type: `string`. Optional. ```bash title="terminal" orc space fields update --config ``` ##### `--is-required` Body field: is_required Type: `string`. Optional. ```bash title="terminal" orc space fields update --is-required ``` ##### `--position` Body field: position Type: `number`. Optional. ```bash title="terminal" orc space fields update --position ``` ##### `--title` Body field: title; max 256 chars Type: `string`. Optional. ```bash title="terminal" orc space fields update --title ``` ### `archive` Archives a field definition. Archived definitions are no longer used, and their values are kept. ```bash title="terminal" orc space fields archive [options] ``` ### `space items fields get` Returns the effective fields and values for an item, including Workspace fields and the nearest explicit project in the folder chain. An unset value is `null`. ```bash title="terminal" orc space items fields get [options] ``` ### `space items fields set` Sets a field value on an item. The value is validated against the field's type and `config`; an invalid value returns 400 without writing. `null` deletes the stored value, including on required fields. ```bash title="terminal" orc space items fields set [options] ``` #### Unique options ##### `--source` Body field: source; enum: user|ai|system Type: `string`. Optional. ```bash title="terminal" orc space items fields set --source ``` ## Global Options The following [global options](https://orchestor.io/docs/cli/global-flags.md) can be used with `orc space fields`: - [`--help`](https://orchestor.io/docs/cli/global-flags.md#help) - [`--workspace`](https://orchestor.io/docs/cli/global-flags.md#workspace) - [`--json`](https://orchestor.io/docs/cli/global-flags.md#json-output) - [`--pretty`](https://orchestor.io/docs/cli/global-flags.md#json-output) - [`--format`](https://orchestor.io/docs/cli/global-flags.md#output-format) - [`--field`](https://orchestor.io/docs/cli/global-flags.md#field-selection) - [`--fields`](https://orchestor.io/docs/cli/global-flags.md#field-selection) - [`--raw`](https://orchestor.io/docs/cli/global-flags.md#raw-output) - [`--output`](https://orchestor.io/docs/cli/global-flags.md#file-output) - [`--no-pager`](https://orchestor.io/docs/cli/global-flags.md#pager) - [`--dry-run`](https://orchestor.io/docs/cli/global-flags.md#dry-run) - [`--yes`](https://orchestor.io/docs/cli/global-flags.md#confirmation) - [`--stdin`](https://orchestor.io/docs/cli/global-flags.md#standard-input) - [`--from-stdin`](https://orchestor.io/docs/cli/global-flags.md#standard-input) - [`--page-all`](https://orchestor.io/docs/cli/global-flags.md#all-pages) - [`--timing`](https://orchestor.io/docs/cli/global-flags.md#request-timing) - [`--readonly`](https://orchestor.io/docs/cli/global-flags.md#read-only-mode) - [`--wrap-untrusted`](https://orchestor.io/docs/cli/global-flags.md#untrusted-content-wrapping) For details and examples, see [global options](https://orchestor.io/docs/cli/global-flags.md). --- [Documentation index](https://orchestor.io/docs/llms.txt)