The field object

• object string: "field"

• id uuid

• type string (enum):

  • "date"

  • "text"

  • "number"

  • "currency"

  • "select"

  • "multiSelect"

  • "multiCollaborator"

  • "createdBy"

  • "lastUpdatedBy"

  • "createdAt"

  • "updatedAt"

• name string

• config object (optional): Depends on the type, see below for more information.

Field types and values

The field type and config define which value the field can be set to on an item.

date

• config: This type is not configurable.

• Field value: date

text

• config: This type is not configurable.

• Field value: string

number

• config object

  • fractionDigits number (optional)

• Field value: number

currency

• config object

  • fractionDigits number (optional)

  • currency string

• Field value: number

select

• config object

  • options Array[object]

    • id uuid

    • name string

• Field value: An object from the configured options

  • id uuid

  • name string

multiSelect

• config object

  • options Array[object]

    • id uuid

    • name string

• Field value: An Array of objects from the configured options

  • id uuid

  • name string

multiCollaborator

• config: This type is not configurable.

• Field value: Array[uuid] (an array of user IDs)

createdBy

• config: This type is not configurable.

• Field value: uuid (user ID)

lastUpdatedBy

• config: This type is not configurable.

• Field value: uuid (user ID)

createdAt

• config object

  • includeTime boolean

• Field value: date or datetime (depending on the includeTime config option)

lastUpdatedAt

• config object

  • includeTime boolean

• Field value: date or datetime (depending on the includeTime config option)

Get fields

Fields are returned as part of the workspace object.

Get field values of an item

Field values are returned as part of the item object.