File
- statusType: integer
System Id requiredID of the system status that determines the file lifecycle stage
- boostType: string
Id read-onlyGlobally unique boost.space identifier for this record (UUID-like)
- createdType: string Format: date-timeread-only
Creation timestamp
- createdType: integer
User Id read-onlyID of user who created this record
- customType: array object[] · FieldValue[]
Fields Values 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 bycustomFieldInputName+module. Values of computed fields (inputTypecalculationandrollup) are read-only: a calculation value is evaluated at read time from the field'sinputCalculationformula and never stored, a rollup value is recomputed automatically from related records; writes to either are ignored.- valuerequired
The field value. Its JSON type follows the field's inputType:
numberreturns an integer;float,moneyandpercentreturn a number;checkboxreturns a boolean;fileandimagereturn the integer id of the uploaded file;date,datetime,gdpr_accept,newsletter_acceptandcookies_acceptreturn a formatted date string;ratingreturns the picked number as a string;selectandradioreturn the option value, never its label (the label is exposed inselected);multiselectandcheckbox_groupreturn the picked option values joined by a pipe, e.g. new|qualified;related_entityreturns the id of the linked record as a string, its module being reported invalueModule;related_entitiesreturns the ids of the linked records joined by a pipe, e.g. 1|2|3;usersreturns a JSON-encoded string — not an object — whose decoded shape carries the keysusers,teamsandcategories, each an array of integer ids;calculationreturns whatever the formula evaluates to, i.e. a string, a number or a boolean;rollupreturns 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_errorkey 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 invalueis rejected with code 4006, sousersandrelated_entitieshave to be sent in the string forms above (arelated_entitiesvalue 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 —numberandcheckboxincluded — comes back as a string. The storage column used internally (valueInt, valueFloat, valueDatetime, valueWysiwyg) is determined by the same inputType. For inputTypecalculationandrollupthis 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:
numberreturns an integer;float,moneyandpercentreturn a number;checkboxreturns a boolean;fileandimagereturn the integer id of the uploaded file;date,datetime,gdpr_accept,newsletter_acceptandcookies_acceptreturn a formatted date string;ratingreturns the picked number as a string;selectandradioreturn the option value, never its label (the label is exposed inselected);multiselectandcheckbox_groupreturn the picked option values joined by a pipe, e.g. new|qualified;related_entityreturns the id of the linked record as a string, its module being reported invalueModule;related_entitiesreturns the ids of the linked records joined by a pipe, e.g. 1|2|3;usersreturns a JSON-encoded string — not an object — whose decoded shape carries the keysusers,teamsandcategories, each an array of integer ids;calculationreturns whatever the formula evaluates to, i.e. a string, a number or a boolean;rollupreturns 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_errorkey 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 invalueis rejected with code 4006, sousersandrelated_entitieshave to be sent in the string forms above (arelated_entitiesvalue 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 —numberandcheckboxincluded — comes back as a string. The storage column used internally (valueInt, valueFloat, valueDatetime, valueWysiwyg) is determined by the same inputType. For inputTypecalculationandrollupthis value is computed by the system and read-only — see the schema description.
- createdType: string Format: date-timeread-only
Creation datetime
- customType: integer
Field Input Id Field id. If this field is not specified, ID is loaded using
customFieldInputNameandmodule - customType: string
Field Input Name Name of field which gets filled. Applied only when
customFieldInputIdis not set - entityType: integer
Id ID of the record (within the given module) that this value is attached to.
- fileType: integer
Id ID of the uploaded file; used when the field inputType is 'file'.
- idType: integerread-only
Unique identifier of this field value record.
- ipType: string
Address IP address from which this value was submitted; used for GDPR, newsletter, and cookie acceptance inputs.
- moduleType: string · All modules in system (dash syntax)
Module this field value belongs to
- selectedType: string | null
Label of the option picked for this value, resolved by matching the whole stored
valueagainst the option values of the field. Filled for the option-based inputTypes —select,multiselectandradio— and null for every other inputType, includingcheckbox, whose state is carried byvalueas a boolean, andcheckbox_group. Because the match runs against the whole stored value, amultiselectholding 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, splitvalueon the pipe and map the option values against the field options. - tableType: string
Module table (if module has more tables). If not filled, is loaded automatically
- translatableType: boolean
Is field translatable
- translationsType: object · TranslationLanguage
- valueType: string Format: date-time
Datetime read-onlyInput value, stored as Datetime (inner db representation of DATETIME value
- valueType: number Format: float
Float read-onlyInput value, stored as Float (inner db representation of DOUBLE value
- valueType: integer
Int read-onlyInput value, stored as Integer (inner db representation of INT value
- valueType: string
Module Module of connected entity. It's only for values from connected-value fields.
- valueType: string
Wysiwyg read-onlyInput value, stored as Wysiwig (inner db representation of TEXT value)
- customType: integer
Type ID of the custom type classification applied to this file
- fileType: string
Name read-onlyInternal filename as stored on disk (may differ from the original upload name)
- filesizeType: stringread-only
Human-readable file size string (e.g. '4 kB')
- idType: integerread-only
Unique identifier - primary key
- isType: boolean
Featured Image When true, this image is used as the featured/cover image for the parent record
- labelsType: array array object[][] · Array of multiple Label objects[]
Labels attached to this file
- Type: array object[] · Array of multiple Label objects
- nameType: string
Original file name (human-readable)
- pathType: string
Relative storage path where the file is persisted on the server or remote storage
- publicType: string
Url read-onlyPublicly accessible URL for reading the file without authentication
- resizeType: array object[] · Array of thumbnails resizes
- createdType: string Format: date-timeread-only
Creation timestamp
- idType: integerread-only
Unique identifier - primary key
- pathType: string
Full file-path
- statusType: object · Status
Full Status object for the user-defined status applied to this file
- iconType: stringrequired
Status icon
- iconType: string
_prefix requiredFont-icon library prefix used to render the icon (e.g. 'fas' for Font Awesome Solid)
- nameType: stringrequired
Status name
- boostType: string
Id read-onlyGlobally unique identifier for this record in the format EntityName0{id}, usable as a stable cross-entity reference
- colorType: string
Status color
- createdType: string Format: date-timeread-only
Creation timestamp
- createdType: integer
_user _id ID of the user who created this status
- idType: integerread-only
Unique identifier - primary key
- spacesType: array integer[]
IDs of spaces this status is scoped to; empty means the status is available globally within its StatusSystem
- statusType: integer
_system _id ID of the StatusSystem this status belongs to
- statusType: object · System status
System StatusSystem object
- weightType: integer
Display order position; lower values appear first
- statusType: integer
Id ID of the user-defined status applied to this file
- statusType: object · System status
System Full StatusSystem object for the system lifecycle status applied to this file
- activatedType: integer
Whether this status system is active and available for use; 1 = active, 0 = inactive
- allowType: string
_move Serialized JSON rule set defining which status transitions are permitted within this status system
- boostType: string
Id read-onlyGlobally unique identifier for this record in the format EntityName0{id}, usable as a stable cross-entity reference
- colorType: string
Status system color
- customType: boolean
Whether this is a user-defined custom status system (1) or a built-in system status system (0)
- iconType: string
Status system icon
- iconType: string
_prefix Font-icon library prefix used to render the icon (e.g. 'fas' for Font Awesome Solid)
- idType: integerread-only
Unique identifier - primary key
- moduleType: string
Module type this status system is associated with (e.g. contact, deal, todo)
- nameType: string
Status system name
- systemType: string
_name Internal system-level identifier for this status system, used to reference built-in status systems by a stable key
- weightType: integer
Display order position; lower values appear first
- storageType: integerread-only
Storage flag (0 = local disk, non-zero = remote/cloud storage)
- typeType: stringread-only
MIME type of the file (e.g. image/png, application/pdf)
- updatedType: string Format: date-timeread-only
Last updated timestamp
- updatedType: integer
User Id read-onlyID of user who last updated this record
- usageType: 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