New: Kith open-sources its ATS.Read why
Skip to Content
Objects

FieldDefinition

A field the workspace keeps on its people, companies or opportunities, beyond the built-in ones: a company's tool stack, a buyer's sales motion. A field can carry an instruction, and then the AI fills it for each record.

type FieldDefinition {
  createdAt: DateTime!
  entity: FieldEntity!
  fillMode: FieldFillMode
  id: ID!
  instruction: String
  key: String!
  label: String!
  options: [String!]!
  status: FieldStatus!
  type: FieldType!
  updatedAt: DateTime!
}

Fields

FieldDefinition.createdAt · DateTime! non-null scalar

When it was created.

FieldDefinition.entity · FieldEntity! non-null enum

The kind of record the field is on. Never changes.

FieldDefinition.fillMode · FieldFillMode enum

How the AI may fill it. Null when the AI does not fill it.

FieldDefinition.id · ID! non-null scalar

The field's id.

FieldDefinition.instruction · String scalar

What the AI should read for and write, in plain language.

FieldDefinition.key · String! non-null scalar

The field's stable name: lower case letters, digits and underscores, such as tool_stack. Unique per workspace and kind of record, and never changes. A key that is a built-in field's name (stage, reports_to) carries the AI's instruction for that built-in field and takes no values of its own.

FieldDefinition.label · String! non-null scalar

The name people see.

FieldDefinition.options · [String!]! non-null scalar

The choices of a SELECT or MULTI_SELECT field. Empty for other types.

FieldDefinition.status · FieldStatus! non-null enum

Whether the field is in use.

FieldDefinition.type · FieldType! non-null enum

What kind of value it holds.

FieldDefinition.updatedAt · DateTime! non-null scalar

When it last changed.

Returned By

fieldDefinition query

Member Of

ActivateFieldDefinitionPayload object · ArchiveFieldDefinitionPayload object · ChangeSuggestionChange object · CreateFieldDefinitionPayload object · FieldDefinitionEdge object · FieldValue object · ProposeFieldDefinitionPayload object · UpdateFieldDefinitionPayload object