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
      Type: string
      required

      The field value as a string; the actual storage column (valueInt, valueFloat, valueDatetime, valueWysiwyg) used internally is determined by the field's 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

      Module name in kebab-case (dash-separated) format, used in URL path parameters. Open set (built-ins plus custom modules); not restricted to an enum.

    • selected
      Type: boolean

      TRUE if this value is selected (used for checkboxes and radio sets)

    • 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