Type Alias GetFieldsResponse

Type Declaration

• [key: string]: unknown

• OptionalappearsByDefault?: boolean

  Indicates if the field is marked as a default in reports.

• Optionalaudited?: boolean

  Indicates if the field is being tracked as part of Quickbase Audit Logs.

• Optionalbold?: boolean

  Indicates if the field is configured to display in bold in the product.

• OptionaldoesDataCopy?: boolean

  Indicates if the field data will copy when a user copies the record.

• OptionalfieldHelp?: string

  The configured help text shown to users within the product.

• OptionalfieldType?: string

  The type of field, as described here.

• OptionalfindEnabled?: boolean

  Indicates if the field is marked as searchable.

• id: number

  The id of the field, unique to this table.

• Optionallabel?: string

  The label (name) of the field.

• Optionalmode?: string

  For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank.

• OptionalnoWrap?: boolean

  Indicates if the field is configured to not wrap when displayed in the product.

• Optionalpermissions?: { permissionType?: string; role?: string; roleId?: number }[]

  Field Permissions for different roles.

• Optionalproperties?: {
      abbreviate?: boolean;
      allowHTML?: boolean;
      allowMentions?: boolean;
      allowNewChoices?: boolean;
      appearsAs?: string;
      appendOnly?: boolean;
      autoSave?: boolean;
      blankIsZero?: boolean;
      carryChoices?: boolean;
      choices?: string[];
      choicesLuid?: string[];
      commaStart?: number;
      comments?: string;
      compositeFields?: (number | Record<string, unknown>)[];
      coverText?: string;
      currencyFormat?: "left" | "right" | "middle";
      currencySymbol?: string;
      decimalPlaces?: number;
      defaultCountryCode?: string;
      defaultDomain?: string;
      defaultKind?: string;
      defaultToday?: boolean;
      defaultValue?: string;
      defaultValueLuid?: number;
      displayAsLink?: boolean;
      displayCheckboxAsText?: boolean;
      displayDayOfWeek?: boolean;
      displayEmail?: string;
      displayMonth?: string;
      displayRelative?: boolean;
      displayTime?: boolean;
      displayTimezone?: boolean;
      displayUser?: string;
      doesAverage?: boolean;
      doesTotal?: boolean;
      durationField?: number;
      exact?: boolean;
      foreignKey?: boolean;
      format?: number;
      formula?: string;
      hasExtension?: boolean;
      hours24?: boolean;
      linkText?: string;
      lookupReferenceFieldId?: number;
      lookupTargetFieldId?: number;
      masterChoiceFieldId?: number;
      masterChoiceTableId?: string;
      masterTableTag?: string;
      maxLength?: number;
      maxVersions?: number;
      numberFormat?: number;
      numLines?: number;
      parentFieldId?: number;
      seeVersions?: boolean;
      snapFieldId?: number;
      sortAlpha?: boolean;
      sortAsGiven?: boolean;
      sourceFieldId?: number;
      startField?: number;
      summaryFunction?:
          | "AVG"
          | "SUM"
          | "MAX"
          | "MIN"
          | "STD-DEV"
          | "COUNT"
          | "COMBINED-TEXT"
          | "COMBINED-USER"
          | "DISTINCT-COUNT";
      summaryReferenceFieldId?: number;
      summaryTargetFieldId?: number;
      targetFieldId?: number;
      targetTableId?: string;
      targetTableName?: string;
      units?: string;
      useI18NFormat?: boolean;
      useNewWindow?: boolean;
      versionMode?: "keepallversions"
      | "keeplastversions";
      width?: number;
      workWeek?: number;
      xmlTag?: string;
      [key: string]: unknown;
  }

  Additional properties for the field. Please see Field type details page for more details on the properties for each field type.

  • Optionalabbreviate?: boolean

    Don't show the URL protocol when showing the URL.

  • OptionalallowHTML?: boolean

    Whether this field allows html.

  • OptionalallowMentions?: boolean

    If someone can

    Mention

    users in the rich text field to generate an email notification.

  • OptionalallowNewChoices?: boolean

    Indicates if users can add new choices to a selection list.

  • OptionalappearsAs?: string

    The link text, if empty, the url will be used as link text.

  • OptionalappendOnly?: boolean

    Whether this field is append only.

  • OptionalautoSave?: boolean

    Whether the link field will auto save.

  • OptionalblankIsZero?: boolean

    Whether a blank value is treated the same as 0 in calculations within the product.

  • OptionalcarryChoices?: boolean

    Whether the field should carry its multiple choice fields when copied.

  • Optionalchoices?: string[]

    An array of entries that exist for a field that offers choices to the user.

  • OptionalchoicesLuid?: string[]

    List of user choices.

  • OptionalcommaStart?: number

    The number of digits before commas display in the product, when applicable.

  • Optionalcomments?: string

    The comments entered on the field properties by an administrator.

  • OptionalcompositeFields?: (number | Record<string, unknown>)[]

    An array of the fields that make up a composite field (e.g., address).

  • OptionalcoverText?: string

    An alternate user friendly text that can be used to display a link in the browser.

  • OptionalcurrencyFormat?: "left" | "right" | "middle"

    The currency format used when displaying field values within the product.

  • OptionalcurrencySymbol?: string

    The current symbol used when displaying field values within the product.

  • OptionaldecimalPlaces?: number

    The number of decimal places displayed in the product for this field.

  • OptionaldefaultCountryCode?: string

    Controls the default country shown on international phone widgets on forms. Country code should be entered in the ISO 3166-1 alpha-2 format.

  • OptionaldefaultDomain?: string

    Default email domain.

  • OptionaldefaultKind?: string

    The user default type.

  • OptionaldefaultToday?: boolean

    Indicates if the field value is defaulted today for new records.

  • OptionaldefaultValue?: string

    The default value configured for a field when a new record is added.

  • OptionaldefaultValueLuid?: number

    Default user id value.

  • OptionaldisplayAsLink?: boolean

    Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.

  • OptionaldisplayCheckboxAsText?: boolean

    Indicates whether the checkbox values will be shown as text in reports.

  • OptionaldisplayDayOfWeek?: boolean

    Indicates whether to display the day of the week within the product.

  • OptionaldisplayEmail?: string

    How the email is displayed.

  • OptionaldisplayMonth?: string

    How to display months.

  • OptionaldisplayRelative?: boolean

    Whether to display time as relative.

  • OptionaldisplayTime?: boolean

    Indicates whether to display the time, in addition to the date.

  • OptionaldisplayTimezone?: boolean

    Indicates whether to display the timezone within the product.

  • OptionaldisplayUser?: string

    The configured option for how users display within the product.

  • OptionaldoesAverage?: boolean

    Whether this field averages in reports within the product.

  • OptionaldoesTotal?: boolean

    Whether this field totals in reports within the product.

  • OptionaldurationField?: number

    The duration field id.

  • Optionalexact?: boolean

    Whether an exact match is required for a report link.

  • OptionalforeignKey?: boolean

    Indicates if the field is a foreign key (or reference field) in a relationship.

  • Optionalformat?: number

    The format to display time.

  • Optionalformula?: string

    The formula of the field as configured in Quickbase.

  • OptionalhasExtension?: boolean

    Whether this field has a phone extension.

  • Optionalhours24?: boolean

    Indicates whether or not to display time in the 24-hour format within the product.

  • OptionallinkText?: string

    The configured text value that replaces the URL that users see within the product.

  • OptionallookupReferenceFieldId?: number

    The id of the field that is the reference in the relationship for this lookup.

  • OptionallookupTargetFieldId?: number

    The id of the field that is the target on the master table for this lookup.

  • OptionalmasterChoiceFieldId?: number

    The id of the field that is the reference in the relationship.

  • OptionalmasterChoiceTableId?: string

    The id of the table that is the master in this relationship.

  • OptionalmasterTableTag?: string

    The table alias for the master table in the relationship this field is part of.

  • OptionalmaxLength?: number

    The maximum number of characters allowed for entry in Quickbase for this field.

  • OptionalmaxVersions?: number

    The maximum number of versions configured for a file attachment.

  • OptionalnumberFormat?: number

    The format used for displaying numeric values in the product (decimal, separators, digit group).

  • OptionalnumLines?: number

    The number of lines shown in Quickbase for this text field.

  • OptionalparentFieldId?: number

    The id of the parent composite field, when applicable.

  • OptionalseeVersions?: boolean

    Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.

  • OptionalsnapFieldId?: number

    The id of the field that is used to snapshot values from, when applicable.

  • OptionalsortAlpha?: boolean

    Whether to sort alphabetically, default sort is by record ID.

  • OptionalsortAsGiven?: boolean

    Indicates if the listed entries sort as entered vs alphabetically.

  • OptionalsourceFieldId?: number

    The id of the source field.

  • OptionalstartField?: number

    The start field id.

  • OptionalsummaryFunction?:
        | "AVG"
        | "SUM"
        | "MAX"
        | "MIN"
        | "STD-DEV"
        | "COUNT"
        | "COMBINED-TEXT"
        | "COMBINED-USER"
        | "DISTINCT-COUNT"

    The summary accumulation function type.

  • OptionalsummaryReferenceFieldId?: number

    The id of the field that is the reference in the relationship for this summary.

  • OptionalsummaryTargetFieldId?: number

    The id of the field that is used to aggregate values from the child, when applicable. This displays 0 if the summary function doesn’t require a field selection (like count).

  • OptionaltargetFieldId?: number

    The id of the target field.

  • OptionaltargetTableId?: string

    The id of the target table.

  • OptionaltargetTableName?: string

    The field's target table name.

  • Optionalunits?: string

    The units label.

  • OptionaluseI18NFormat?: boolean

    Whether phone numbers should be in E.164 standard international format.

  • OptionaluseNewWindow?: boolean

    Indicates if the URL should open a new window when a user clicks it within the product.

  • OptionalversionMode?: "keepallversions" | "keeplastversions"

    Version modes for files. Keep all versions vs keep last version.

  • Optionalwidth?: number

    The field's html input width in the product.

  • OptionalworkWeek?: number

    The work week type.

  • OptionalxmlTag?: string

    The field's xml tag.

• Optionalrequired?: boolean

  Indicates if the field is marked required.

• Optionalunique?: boolean

  Indicates if the field is marked unique.