File

  • statusSystemId
    Type: integer
    required

    ID of the system status that determines the file lifecycle stage

  • boostId
    Type: string
    read-only

    Globally unique boost.space identifier for this record (UUID-like)

  • created
    Type: string Format: date-time
    read-only

    Creation timestamp

  • createdUserId
    Type: integer
    read-only

    ID of user who created this record

  • customFieldsValues
    Type: array object[] · FieldValue[]

    Values of space-specific custom fields attached to this file

    A single custom field value attached to a record. The field is identified either by customFieldInputId, or by customFieldInputName + module. Values of computed fields (inputType calculation and rollup) are read-only: a calculation value is evaluated at read time from the field's inputCalculation formula and never stored, a rollup value is recomputed automatically from related records; writes to either are ignored.

    • value
      required

      The field value. Its JSON type follows the field's inputType: number returns an integer; float, money and percent return a number; checkbox returns a boolean; file and image return the integer id of the uploaded file; date, datetime, gdpr_accept, newsletter_accept and cookies_accept return a formatted date string; rating returns the picked number as a string; select and radio return the option value, never its label (the label is exposed in selected); multiselect and checkbox_group return the picked option values joined by a pipe, e.g. new|qualified; related_entity returns the id of the linked record as a string, its module being reported in valueModule; related_entities returns the ids of the linked records joined by a pipe, e.g. 1|2|3; users returns a JSON-encoded string — not an object — whose decoded shape carries the keys users, teams and categories, each an array of integer ids; calculation returns whatever the formula evaluates to, i.e. a string, a number or a boolean; rollup returns an array of the collected values for SHOW_ORIGINAL and SHOW_UNIQUE, a number or a date string for scalar aggregations, or an object carrying a single _error key when the aggregation fails; every other inputType returns a string. Writes accept the same shapes, but only as JSON scalars: an array or an object in value is rejected with code 4006, so users and related_entities have to be sent in the string forms above (a related_entities value that is neither pipe-separated nor a single numeric id is rejected with code 4017). Custom field values nested in a Space are serialised through a separate string-cast path, so there every inputType — number and checkbox included — comes back as a string. The storage column used internally (valueInt, valueFloat, valueDatetime, valueWysiwyg) is determined by the same inputType. For inputType calculation and rollup this value is computed by the system and read-only — see the schema description.

      • Type: string

        The field value. Its JSON type follows the field's inputType: number returns an integer; float, money and percent return a number; checkbox returns a boolean; file and image return the integer id of the uploaded file; date, datetime, gdpr_accept, newsletter_accept and cookies_accept return a formatted date string; rating returns the picked number as a string; select and radio return the option value, never its label (the label is exposed in selected); multiselect and checkbox_group return the picked option values joined by a pipe, e.g. new|qualified; related_entity returns the id of the linked record as a string, its module being reported in valueModule; related_entities returns the ids of the linked records joined by a pipe, e.g. 1|2|3; users returns a JSON-encoded string — not an object — whose decoded shape carries the keys users, teams and categories, each an array of integer ids; calculation returns whatever the formula evaluates to, i.e. a string, a number or a boolean; rollup returns an array of the collected values for SHOW_ORIGINAL and SHOW_UNIQUE, a number or a date string for scalar aggregations, or an object carrying a single _error key when the aggregation fails; every other inputType returns a string. Writes accept the same shapes, but only as JSON scalars: an array or an object in value is rejected with code 4006, so users and related_entities have to be sent in the string forms above (a related_entities value that is neither pipe-separated nor a single numeric id is rejected with code 4017). Custom field values nested in a Space are serialised through a separate string-cast path, so there every inputType — number and checkbox included — comes back as a string. The storage column used internally (valueInt, valueFloat, valueDatetime, valueWysiwyg) is determined by the same inputType. For inputType calculation and rollup this value is computed by the system and read-only — see the schema description.

    • created
      Type: string Format: date-time
      read-only

      Creation datetime

    • customFieldInputId
      Type: integer

      Field id. If this field is not specified, ID is loaded using customFieldInputName and module

    • customFieldInputName
      Type: string

      Name of field which gets filled. Applied only when customFieldInputId is not set

    • entityId
      Type: integer

      ID of the record (within the given module) that this value is attached to.

    • fileId
      Type: integer

      ID of the uploaded file; used when the field inputType is 'file'.

    • id
      Type: integer
      read-only

      Unique identifier of this field value record.

    • ipAddress
      Type: string

      IP address from which this value was submitted; used for GDPR, newsletter, and cookie acceptance inputs.

    • module
      Type: string · All modules in system (dash syntax)

      Module this field value belongs to

    • selected
      Type: string | null

      Label of the option picked for this value, resolved by matching the whole stored value against the option values of the field. Filled for the option-based inputTypes — select, multiselect and radio — and null for every other inputType, including checkbox, whose state is carried by value as a boolean, and checkbox_group. Because the match runs against the whole stored value, a multiselect holding several pipe-joined options resolves to null; only a single picked option yields a label. This property therefore never carries a list of labels — to get the labels of several picked options, split value on the pipe and map the option values against the field options.

    • table
      Type: string

      Module table (if module has more tables). If not filled, is loaded automatically

    • translatable
      Type: boolean

      Is field translatable

    • translations
      Type: object · TranslationLanguage
    • valueDatetime
      Type: string Format: date-time
      read-only

      Input value, stored as Datetime (inner db representation of DATETIME value

    • valueFloat
      Type: number Format: float
      read-only

      Input value, stored as Float (inner db representation of DOUBLE value

    • valueInt
      Type: integer
      read-only

      Input value, stored as Integer (inner db representation of INT value

    • valueModule
      Type: string

      Module of connected entity. It's only for values from connected-value fields.

    • valueWysiwyg
      Type: string
      read-only

      Input value, stored as Wysiwig (inner db representation of TEXT value)

  • customType
    Type: integer

    ID of the custom type classification applied to this file

  • fileName
    Type: string
    read-only

    Internal filename as stored on disk (may differ from the original upload name)

  • filesize
    Type: string
    read-only

    Human-readable file size string (e.g. '4 kB')

  • id
    Type: integer
    read-only

    Unique identifier - primary key

  • isFeaturedImage
    Type: boolean

    When true, this image is used as the featured/cover image for the parent record

  • labels
    Type: array array object[][] · Array of multiple Label objects[]

    Labels attached to this file

    • Type: array object[] · Array of multiple Label objects
  • name
    Type: string

    Original file name (human-readable)

  • path
    Type: string

    Relative storage path where the file is persisted on the server or remote storage

  • publicUrl
    Type: string
    read-only

    Publicly accessible URL for reading the file without authentication

  • resize
    Type: array object[] · Array of thumbnails resizes
    • created
      Type: string Format: date-time
      read-only

      Creation timestamp

    • id
      Type: integer
      read-only

      Unique identifier - primary key

    • path
      Type: string

      Full file-path

  • status
    Type: object · Status

    Full Status object for the user-defined status applied to this file

    • icon
      Type: string
      required

      Status icon

    • icon_prefix
      Type: string
      required

      Font-icon library prefix used to render the icon (e.g. 'fas' for Font Awesome Solid)

    • name
      Type: string
      required

      Status name

    • boostId
      Type: string
      read-only

      Globally unique identifier for this record in the format EntityName0{id}, usable as a stable cross-entity reference

    • color
      Type: string

      Status color

    • created
      Type: string Format: date-time
      read-only

      Creation timestamp

    • created_user_id
      Type: integer

      ID of the user who created this status

    • id
      Type: integer
      read-only

      Unique identifier - primary key

    • spaces
      Type: array integer[]

      IDs of spaces this status is scoped to; empty means the status is available globally within its StatusSystem

    • status_system_id
      Type: integer

      ID of the StatusSystem this status belongs to

    • statusSystem
      Type: object · System status

      StatusSystem object

    • weight
      Type: integer

      Display order position; lower values appear first

  • statusId
    Type: integer

    ID of the user-defined status applied to this file

  • statusSystem
    Type: object · System status

    Full StatusSystem object for the system lifecycle status applied to this file

    • activated
      Type: integer

      Whether this status system is active and available for use; 1 = active, 0 = inactive

    • allow_move
      Type: string

      Serialized JSON rule set defining which status transitions are permitted within this status system

    • boostId
      Type: string
      read-only

      Globally unique identifier for this record in the format EntityName0{id}, usable as a stable cross-entity reference

    • color
      Type: string

      Status system color

    • custom
      Type: boolean

      Whether this is a user-defined custom status system (1) or a built-in system status system (0)

    • icon
      Type: string

      Status system icon

    • icon_prefix
      Type: string

      Font-icon library prefix used to render the icon (e.g. 'fas' for Font Awesome Solid)

    • id
      Type: integer
      read-only

      Unique identifier - primary key

    • module
      Type: string

      Module type this status system is associated with (e.g. contact, deal, todo)

    • name
      Type: string

      Status system name

    • system_name
      Type: string

      Internal system-level identifier for this status system, used to reference built-in status systems by a stable key

    • weight
      Type: integer

      Display order position; lower values appear first

  • storage
    Type: integer
    read-only

    Storage flag (0 = local disk, non-zero = remote/cloud storage)

  • type
    Type: string
    read-only

    MIME type of the file (e.g. image/png, application/pdf)

  • updated
    Type: string Format: date-time
    read-only

    Last updated timestamp

  • updatedUserId
    Type: integer
    read-only

    ID of user who last updated this record

  • usage
    Type: array array object[][] · Array of multiple FileUsage objects[]
    read-only

    List of records across modules that reference this file

    • Type: array object[] · Array of multiple FileUsage objects