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: stringFormat: date-time
    read-only

    Creation timestamp

  • createdUserId
    Type: integer
    read-only

    ID of user who created this record

  • customFieldsValues
    Type:

    Values of space-specific custom fields attached to this file

    Properties: 18
  • 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:

    Labels attached to this file

  • name
    Type: string

    Original file name (human-readable)

  • path
    Type: string
    read-only

    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 of FileResize
    Properties: 3
  • status
    Type:

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

    Properties: 12
  • statusId
    Type: integer

    ID of the user-defined status applied to this file

  • statusSystem
    Type:

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

    Properties: 12
  • 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: stringFormat: date-time
    read-only

    Last updated timestamp

  • updatedUserId
    Type: integer
    read-only

    ID of user who last updated this record

  • usage
    Type:
    read-only

    List of records across modules that reference this file

Previous
File usage information
Next
Array of multiple Label objects