openapi: 3.0.3 info: title: Baserow API spec Admin Database table fields API version: 2.2.2 description: 'For more information about our REST API, please visit [this page](https://baserow.io/docs/apis%2Frest-api). For more information about our deprecation policy, please visit [this page](https://baserow.io/docs/apis%2Fdeprecations).' contact: url: https://baserow.io/contact license: name: MIT url: https://github.com/baserow/baserow/blob/develop/LICENSE tags: - name: Database table fields paths: /api/database/fields/{field_id}/: get: operationId: get_database_table_field description: Returns the existing field if the authorized user has access to the related database's workspace. Depending on the type different properties could be returned. parameters: - in: path name: field_id schema: type: integer description: Returns the field related to the provided value. required: true tags: - Database table fields security: - UserSource JWT: [] - JWT: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FieldField' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_USER_NOT_IN_GROUP detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_FIELD_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' patch: operationId: update_database_table_field description: Updates the existing field if the authorized user has access to the related database's workspace. The type can also be changed and depending on that type, different additional properties can optionally be set. If you change the field type it could happen that the data conversion fails, in that case the `ERROR_CANNOT_CHANGE_FIELD_TYPE` is returned, but this rarely happens. If a data value cannot be converted it is set to `null` so data might go lost.If updated the field causes other fields to change then the specificinstances of those fields will be included in the related fields response key. parameters: - in: header name: ClientSessionId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone. - in: header name: ClientUndoRedoActionGroupId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call. - in: path name: field_id schema: type: integer description: Updates the field related to the provided value. required: true tags: - Database table fields requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedFieldUpdateField' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedFieldUpdateField' multipart/form-data: schema: $ref: '#/components/schemas/PatchedFieldUpdateField' security: - UserSource JWT: [] - JWT: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FieldFieldSerializerWithRelatedFields' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_USER_NOT_IN_GROUP - ERROR_CANNOT_CHANGE_FIELD_TYPE - ERROR_REQUEST_BODY_VALIDATION - ERROR_RESERVED_BASEROW_FIELD_NAME - ERROR_FIELD_WITH_SAME_NAME_ALREADY_EXISTS - ERROR_INVALID_BASEROW_FIELD_NAME - ERROR_FIELD_SELF_REFERENCE - ERROR_FIELD_CIRCULAR_REFERENCE detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_FIELD_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' delete: operationId: delete_database_table_field description: Deletes the existing field if the authorized user has access to the related database's workspace. Note that all the related data to that field is also deleted. Primary fields cannot be deleted because their value represents the row. If deleting the field causes other fields to change then the specificinstances of those fields will be included in the related fields response key. parameters: - in: header name: ClientSessionId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone. - in: header name: ClientUndoRedoActionGroupId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call. - in: path name: field_id schema: type: integer description: Deletes the field related to the provided value. required: true tags: - Database table fields security: - UserSource JWT: [] - JWT: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RelatedFields' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_USER_NOT_IN_GROUP - ERROR_CANNOT_DELETE_PRIMARY_FIELD - ERROR_CANNOT_DELETE_ALREADY_DELETED_ITEM detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_FIELD_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' /api/database/fields/{field_id}/duplicate/async/: post: operationId: duplicate_table_field description: Duplicates the table with the provided `table_id` parameter if the authorized user has access to the database's workspace. parameters: - in: header name: ClientSessionId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone. - in: header name: ClientUndoRedoActionGroupId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call. - in: path name: field_id schema: type: integer description: The field to duplicate. required: true tags: - Database table fields security: - UserSource JWT: [] - JWT: [] responses: '202': content: application/json: schema: $ref: '#/components/schemas/DuplicateFieldJobTypeResponse' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_USER_NOT_IN_GROUP - ERROR_REQUEST_BODY_VALIDATION - ERROR_MAX_JOB_COUNT_EXCEEDED detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_FIELD_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' /api/database/fields/{field_id}/generate-ai-field-values/: post: operationId: generate_table_ai_field_value description: "Endpoint that's used by the AI field to start an sync task that will update the cell value of the provided row IDs based on the dynamically constructed prompt configured in the field settings. \nThis is a **premium** feature." parameters: - in: header name: ClientSessionId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone. - in: header name: ClientUndoRedoActionGroupId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call. - in: path name: field_id schema: type: integer description: The field to generate the value for. required: true tags: - Database table fields requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateAIFieldValueView' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/GenerateAIFieldValueView' multipart/form-data: schema: $ref: '#/components/schemas/GenerateAIFieldValueView' required: true security: - UserSource JWT: [] - JWT: [] responses: '202': content: application/json: schema: $ref: '#/components/schemas/GenerateAIValuesJobTypeResponse' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_GENERATIVE_AI_DOES_NOT_EXIST - ERROR_MODEL_DOES_NOT_BELONG_TO_TYPE detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_FIELD_DOES_NOT_EXIST - ERROR_ROW_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' /api/database/fields/{field_id}/unique_row_values/: get: operationId: get_database_field_unique_row_values description: Returns a list of all the unique row values for an existing field, sorted in order of frequency. parameters: - in: path name: field_id schema: type: integer description: Returns the values related to the provided field. required: true - in: query name: limit schema: type: integer description: Defines how many values should be returned. - in: query name: split_comma_separated schema: type: boolean description: Indicates whether the original column values must be splitted by comma. tags: - Database table fields security: - UserSource JWT: [] - JWT: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UniqueRowValues' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_USER_NOT_IN_GROUP detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_FIELD_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' /api/database/fields/password-authentication/: post: operationId: password_field_authentication description: Checks if the provided password and row matches what is stored in the cell. The field must have `allow_endpoint_authentication` set to `true` in order to work. tags: - Database table fields requestBody: content: application/json: schema: $ref: '#/components/schemas/PasswordFieldAuthentication' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PasswordFieldAuthentication' multipart/form-data: schema: $ref: '#/components/schemas/PasswordFieldAuthentication' required: true security: - UserSource JWT: [] - JWT: [] - Database token: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PasswordFieldAuthenticationResponse' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_REQUEST_BODY_VALIDATION detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '401': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_NO_PERMISSION_TO_TABLE - ERROR_INVALID_PASSWORD_FIELD_PASSWORD detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_FIELD_DOES_NOT_EXIST - ERROR_ROW_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' /api/database/fields/table/{table_id}/: get: operationId: list_database_table_fields description: Lists all the fields of the table related to the provided parameter if the user has access to the related database's workspace. If the workspace is related to a template, then this endpoint will be publicly accessible. A table consists of fields and each field can have a different type. Each type can have different properties. A field is comparable with a regular table's column. parameters: - in: path name: table_id schema: type: integer description: Returns only the fields of the table related to the provided value. required: true tags: - Database table fields security: - UserSource JWT: [] - JWT: [] - Database token: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/FieldField' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_USER_NOT_IN_GROUP detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '401': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_NO_PERMISSION_TO_TABLE detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_TABLE_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' post: operationId: create_database_table_field description: Creates a new field for the table related to the provided `table_id` parameter if the authorized user has access to the related database's workspace. Depending on the type, different properties can optionally be set.If creating the field causes other fields to change then the specificinstances of those fields will be included in the related fields response key. parameters: - in: header name: ClientSessionId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone. - in: header name: ClientUndoRedoActionGroupId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call. - in: path name: table_id schema: type: integer description: Creates a new field for the provided table related to the value. required: true tags: - Database table fields requestBody: content: application/json: schema: $ref: '#/components/schemas/FieldCreateField' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/FieldCreateField' multipart/form-data: schema: $ref: '#/components/schemas/FieldCreateField' security: - UserSource JWT: [] - JWT: [] - Database token: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FieldFieldSerializerWithRelatedFields' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_USER_NOT_IN_GROUP - ERROR_REQUEST_BODY_VALIDATION - ERROR_MAX_FIELD_COUNT_EXCEEDED - ERROR_RESERVED_BASEROW_FIELD_NAME - ERROR_FIELD_WITH_SAME_NAME_ALREADY_EXISTS - ERROR_INVALID_BASEROW_FIELD_NAME - ERROR_FIELD_SELF_REFERENCE - ERROR_FIELD_CIRCULAR_REFERENCE - ERROR_IMMUTABLE_FIELD_PROPERTIES detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '401': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_NO_PERMISSION_TO_TABLE detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_TABLE_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' /api/database/fields/table/{table_id}/change-primary-field/: post: operationId: change_primary_field description: Changes the primary field of a table to the one provided in the body payload. parameters: - in: header name: ClientSessionId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone. - in: header name: ClientUndoRedoActionGroupId schema: type: string format: uuid description: An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call. - in: path name: table_id schema: type: integer description: The table where to update the primary field in. required: true tags: - Database table fields requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePrimaryFieldParams' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ChangePrimaryFieldParams' multipart/form-data: schema: $ref: '#/components/schemas/ChangePrimaryFieldParams' required: true security: - UserSource JWT: [] - JWT: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FieldField' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_USER_NOT_IN_GROUP - ERROR_REQUEST_BODY_VALIDATION - ERROR_USER_NOT_IN_GROUP - ERROR_FIELD_IS_ALREADY_PRIMARY - ERROR_FIELD_NOT_IN_TABLE - ERROR_INCOMPATIBLE_PRIMARY_FIELD_TYPE - ERROR_TABLE_HAS_NO_PRIMARY_FIELD detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_TABLE_DOES_NOT_EXIST - ERROR_FIELD_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' /api/database/fields/table/{table_id}/generate-ai-formula/: post: operationId: generate_formula_with_ai description: 'This endpoint generates a Baserow formula for the table related to the provided id, based on the human readable input provided in the request body. This is a **premium** feature.' parameters: - in: path name: table_id schema: type: integer description: The table to generate the formula for. required: true tags: - Database table fields requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateFormulaWithAIRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/GenerateFormulaWithAIRequest' multipart/form-data: schema: $ref: '#/components/schemas/GenerateFormulaWithAIRequest' required: true security: - UserSource JWT: [] - JWT: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GenerateFormulaWithAIResponse' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_GENERATIVE_AI_DOES_NOT_EXIST - ERROR_MODEL_DOES_NOT_BELONG_TO_TYPE - ERROR_GENERATIVE_AI_PROMPT - ERROR_USER_NOT_IN_GROUP detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_TABLE_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' /api/database/formula/{table_id}/type/: post: operationId: type_formula_field description: Calculates and returns the type of the specified formula value. Does not change the state of the field in any way. parameters: - in: path name: table_id schema: type: integer description: The table id of the formula field to type. required: true tags: - Database table fields requestBody: content: application/json: schema: $ref: '#/components/schemas/TypeFormulaRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TypeFormulaRequest' multipart/form-data: schema: $ref: '#/components/schemas/TypeFormulaRequest' required: true security: - UserSource JWT: [] - JWT: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TypeFormulaResult' description: '' '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_USER_NOT_IN_GROUP - ERROR_REQUEST_BODY_VALIDATION - ERROR_WITH_FORMULA - ERROR_FIELD_SELF_REFERENCE detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_TABLE_DOES_NOT_EXIST detail: oneOf: - type: string format: string description: Human readable details about what went wrong. - type: object format: object description: Machine readable object about what went wrong. description: '' components: schemas: NullEnum: enum: - null PhoneNumberFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id SingleSelectFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' select_options: type: array items: $ref: '#/components/schemas/SelectOption' single_select_default: type: integer nullable: true required: - name - type FileFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' GenerateFormulaWithAIRequest: type: object properties: ai_type: type: string description: The AI model type that must be used when generating the formula. ai_model: type: string description: The AI model that must be used when generating the formula. ai_temperature: type: number format: double maximum: 2 minimum: 0 nullable: true description: Between 0 and 2, adjusts response randomness—lower values yield focused answers, while higher values increase creativity. ai_prompt: type: string description: The human readable input used to generate the formula. maxLength: 1000 required: - ai_model - ai_prompt - ai_type FieldField: oneOf: - $ref: '#/components/schemas/TextFieldField' - $ref: '#/components/schemas/LongTextFieldField' - $ref: '#/components/schemas/URLFieldField' - $ref: '#/components/schemas/EmailFieldField' - $ref: '#/components/schemas/NumberFieldField' - $ref: '#/components/schemas/RatingFieldField' - $ref: '#/components/schemas/BooleanFieldField' - $ref: '#/components/schemas/DateFieldField' - $ref: '#/components/schemas/LastModifiedFieldField' - $ref: '#/components/schemas/LastModifiedByFieldField' - $ref: '#/components/schemas/CreatedOnFieldField' - $ref: '#/components/schemas/CreatedByFieldField' - $ref: '#/components/schemas/DurationFieldField' - $ref: '#/components/schemas/LinkRowFieldField' - $ref: '#/components/schemas/FileFieldField' - $ref: '#/components/schemas/SingleSelectFieldField' - $ref: '#/components/schemas/MultipleSelectFieldField' - $ref: '#/components/schemas/PhoneNumberFieldField' - $ref: '#/components/schemas/FormulaFieldField' - $ref: '#/components/schemas/CountFieldField' - $ref: '#/components/schemas/RollupFieldField' - $ref: '#/components/schemas/LookupFieldField' - $ref: '#/components/schemas/MultipleCollaboratorsFieldField' - $ref: '#/components/schemas/UUIDFieldField' - $ref: '#/components/schemas/AutonumberFieldField' - $ref: '#/components/schemas/PasswordFieldField' - $ref: '#/components/schemas/FormViewEditRowFieldField' - $ref: '#/components/schemas/AIFieldField' discriminator: propertyName: type mapping: text: '#/components/schemas/TextFieldField' long_text: '#/components/schemas/LongTextFieldField' url: '#/components/schemas/URLFieldField' email: '#/components/schemas/EmailFieldField' number: '#/components/schemas/NumberFieldField' rating: '#/components/schemas/RatingFieldField' boolean: '#/components/schemas/BooleanFieldField' date: '#/components/schemas/DateFieldField' last_modified: '#/components/schemas/LastModifiedFieldField' last_modified_by: '#/components/schemas/LastModifiedByFieldField' created_on: '#/components/schemas/CreatedOnFieldField' created_by: '#/components/schemas/CreatedByFieldField' duration: '#/components/schemas/DurationFieldField' link_row: '#/components/schemas/LinkRowFieldField' file: '#/components/schemas/FileFieldField' single_select: '#/components/schemas/SingleSelectFieldField' multiple_select: '#/components/schemas/MultipleSelectFieldField' phone_number: '#/components/schemas/PhoneNumberFieldField' formula: '#/components/schemas/FormulaFieldField' count: '#/components/schemas/CountFieldField' rollup: '#/components/schemas/RollupFieldField' lookup: '#/components/schemas/LookupFieldField' multiple_collaborators: '#/components/schemas/MultipleCollaboratorsFieldField' uuid: '#/components/schemas/UUIDFieldField' autonumber: '#/components/schemas/AutonumberFieldField' password: '#/components/schemas/PasswordFieldField' form_view_edit_row: '#/components/schemas/FormViewEditRowFieldField' ai: '#/components/schemas/AIFieldField' DateTimeFormatEnum: enum: - '24' - '12' type: string description: '* `24` - 24 hour * `12` - 12 hour' BooleanFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' boolean_default: type: boolean description: The default value for field if none is provided. BooleanFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' boolean_default: type: boolean description: The default value for field if none is provided. required: - name - type FormulaFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. number_suffix: type: string description: The suffix to use for the field. maxLength: 10 number_decimal_places: nullable: true description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' - $ref: '#/components/schemas/NullEnum' array_formula_type: nullable: true oneOf: - $ref: '#/components/schemas/ArrayFormulaTypeEnum' - $ref: '#/components/schemas/NullEnum' duration_format: nullable: true description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' oneOf: - $ref: '#/components/schemas/DurationFormatEnum' - $ref: '#/components/schemas/NullEnum' error: type: string readOnly: true date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 select_options: type: array items: $ref: '#/components/schemas/SelectOption' readOnly: true nullable: true date_format: nullable: true description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' oneOf: - $ref: '#/components/schemas/DateFormatEnum' - $ref: '#/components/schemas/NullEnum' nullable: type: boolean readOnly: true date_time_format: nullable: true description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' oneOf: - $ref: '#/components/schemas/DateTimeFormatEnum' - $ref: '#/components/schemas/NullEnum' number_negative: type: boolean readOnly: true default: true available_collaborators: type: array items: $ref: '#/components/schemas/Collaborator' readOnly: true nullable: true description: A list of all the available collaborators. date_show_tzinfo: type: boolean nullable: true description: Indicates if the time zone should be shown. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' date_include_time: type: boolean nullable: true description: Indicates if the field also includes a time. formula: type: string formula_type: $ref: '#/components/schemas/FormulaTypeEnum' required: - available_collaborators - database_id - error - field_constraints - formula - id - immutable_properties - immutable_type - name - nullable - number_negative - order - read_only - related_fields - select_options - table_id - type - workspace_id TypeFormulaRequest: type: object properties: formula: type: string name: type: string maxLength: 255 required: - formula - name UUIDFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id GenerateFormulaWithAIResponse: type: object properties: formula: type: string description: The formula generated by the AI. required: - formula GenerateAIValuesJobTypeResponse: type: object properties: id: type: integer readOnly: true type: type: string readOnly: true description: The type of the job. progress_percentage: type: integer description: A percentage indicating how far along the job is. 100 means that it's finished. state: type: string description: Indicates the state of the import job. human_readable_error: type: string description: A human readable error message indicating what went wrong. created_on: type: string format: date-time readOnly: true updated_on: type: string format: date-time readOnly: true field_id: type: integer description: The ID of the AI field to generate values for. row_ids: type: array items: type: integer description: The IDs of the rows to generate AI values for. If not provided, all rows in the view or table will be processed. view_id: type: integer description: The ID of the view to generate AI values for. If not provided, the entire table will be processed. only_empty: type: boolean description: Whether to only generate AI values for rows where the field is empty. is_auto_update: type: boolean readOnly: true description: Indicates if the job has been created because values in a dependent field changed. required: - created_on - field_id - id - is_auto_update - progress_percentage - state - type - updated_on LastModifiedFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. date_format: allOf: - $ref: '#/components/schemas/DateFormatEnum' description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' date_include_time: type: boolean description: Indicates if the field also includes a time. date_time_format: allOf: - $ref: '#/components/schemas/DateTimeFormatEnum' description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' date_show_tzinfo: type: boolean description: Indicates if the timezone should be shown. date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 required: - database_id - field_constraints - id - immutable_properties - immutable_type - order - read_only - related_fields - table_id - type - workspace_id ArrayFormulaTypeEnum: enum: - invalid - text - char - button - link - date_interval - duration - date - boolean - number - single_select - multiple_select - single_file - url - multiple_collaborators type: string description: '* `invalid` - invalid * `text` - text * `char` - char * `button` - button * `link` - link * `date_interval` - date_interval * `duration` - duration * `date` - date * `boolean` - boolean * `number` - number * `single_select` - single_select * `multiple_select` - multiple_select * `single_file` - single_file * `url` - url * `multiple_collaborators` - multiple_collaborators' RatingFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. max_value: type: integer maximum: 10 minimum: 1 description: Maximum value the rating can take. color: type: string description: Color of the symbols. maxLength: 50 style: allOf: - $ref: '#/components/schemas/StyleEnum' description: 'Rating style. Allowed values: star, heart, thumbs-up, flag, smile. * `star` - Star * `heart` - Heart * `thumbs-up` - Thumbs Up * `flag` - Flag * `smile` - Smile' required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id FormulaFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' number_suffix: type: string description: The suffix to use for the field. maxLength: 10 number_decimal_places: nullable: true description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' - $ref: '#/components/schemas/NullEnum' array_formula_type: nullable: true oneOf: - $ref: '#/components/schemas/ArrayFormulaTypeEnum' - $ref: '#/components/schemas/NullEnum' duration_format: nullable: true description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' oneOf: - $ref: '#/components/schemas/DurationFormatEnum' - $ref: '#/components/schemas/NullEnum' error: type: string readOnly: true date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 date_format: nullable: true description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' oneOf: - $ref: '#/components/schemas/DateFormatEnum' - $ref: '#/components/schemas/NullEnum' nullable: type: boolean readOnly: true date_time_format: nullable: true description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' oneOf: - $ref: '#/components/schemas/DateTimeFormatEnum' - $ref: '#/components/schemas/NullEnum' date_show_tzinfo: type: boolean nullable: true description: Indicates if the time zone should be shown. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' date_include_time: type: boolean nullable: true description: Indicates if the field also includes a time. formula: type: string formula_type: $ref: '#/components/schemas/FormulaTypeEnum' required: - error - formula - name - nullable - type AutonumberFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' view_id: type: integer nullable: true description: The id of the view to use for the initial ordering. EmailFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id CreatedByFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. available_collaborators: type: array items: $ref: '#/components/schemas/Collaborator' readOnly: true description: A list of all the available collaborators. required: - available_collaborators - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id LastModifiedByFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' LookupFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. number_suffix: type: string description: The suffix to use for the field. maxLength: 10 number_decimal_places: nullable: true description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' - $ref: '#/components/schemas/NullEnum' array_formula_type: nullable: true oneOf: - $ref: '#/components/schemas/ArrayFormulaTypeEnum' - $ref: '#/components/schemas/NullEnum' duration_format: nullable: true description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' oneOf: - $ref: '#/components/schemas/DurationFormatEnum' - $ref: '#/components/schemas/NullEnum' error: type: string readOnly: true date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 select_options: type: array items: $ref: '#/components/schemas/SelectOption' readOnly: true nullable: true date_format: nullable: true description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' oneOf: - $ref: '#/components/schemas/DateFormatEnum' - $ref: '#/components/schemas/NullEnum' nullable: type: boolean readOnly: true date_time_format: nullable: true description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' oneOf: - $ref: '#/components/schemas/DateTimeFormatEnum' - $ref: '#/components/schemas/NullEnum' number_negative: type: boolean readOnly: true default: true available_collaborators: type: array items: $ref: '#/components/schemas/Collaborator' readOnly: true nullable: true description: A list of all the available collaborators. date_show_tzinfo: type: boolean nullable: true description: Indicates if the time zone should be shown. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' date_include_time: type: boolean nullable: true description: Indicates if the field also includes a time. through_field_id: type: integer nullable: true description: The id of the link row field to lookup values for. Will override the `through_field_name` parameter if both are provided, however only one is required. through_field_name: type: string nullable: true description: The name of the link row field to lookup values for. target_field_id: type: integer nullable: true description: The id of the field in the table linked to by the through_field to lookup. Will override the `target_field_id` parameter if both are provided, however only one is required. target_field_name: type: string nullable: true description: The name of the field in the table linked to by the through_field to lookup. formula_type: $ref: '#/components/schemas/FormulaTypeEnum' required: - available_collaborators - database_id - error - field_constraints - id - immutable_properties - immutable_type - name - nullable - number_negative - order - read_only - related_fields - select_options - table_id - type - workspace_id MultipleCollaboratorsFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. available_collaborators: type: array items: $ref: '#/components/schemas/Collaborator' readOnly: true description: A list of all the available collaborators. notify_user_when_added: type: boolean required: - available_collaborators - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id RelatedFields: type: object properties: related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. required: - related_fields LookupFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' number_suffix: type: string description: The suffix to use for the field. maxLength: 10 number_decimal_places: nullable: true description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' - $ref: '#/components/schemas/NullEnum' array_formula_type: nullable: true oneOf: - $ref: '#/components/schemas/ArrayFormulaTypeEnum' - $ref: '#/components/schemas/NullEnum' duration_format: nullable: true description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' oneOf: - $ref: '#/components/schemas/DurationFormatEnum' - $ref: '#/components/schemas/NullEnum' error: type: string readOnly: true date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 date_format: nullable: true description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' oneOf: - $ref: '#/components/schemas/DateFormatEnum' - $ref: '#/components/schemas/NullEnum' nullable: type: boolean readOnly: true date_time_format: nullable: true description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' oneOf: - $ref: '#/components/schemas/DateTimeFormatEnum' - $ref: '#/components/schemas/NullEnum' date_show_tzinfo: type: boolean nullable: true description: Indicates if the time zone should be shown. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' date_include_time: type: boolean nullable: true description: Indicates if the field also includes a time. through_field_id: type: integer nullable: true description: The id of the link row field to lookup values for. Will override the `through_field_name` parameter if both are provided, however only one is required. through_field_name: type: string nullable: true description: The name of the link row field to lookup values for. target_field_id: type: integer nullable: true description: The id of the field in the table linked to by the through_field to lookup. Will override the `target_field_id` parameter if both are provided, however only one is required. target_field_name: type: string nullable: true description: The name of the field in the table linked to by the through_field to lookup. formula_type: $ref: '#/components/schemas/FormulaTypeEnum' required: - error - name - nullable - type CreatedOnFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. date_format: allOf: - $ref: '#/components/schemas/DateFormatEnum' description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' date_include_time: type: boolean description: Indicates if the field also includes a time. date_time_format: allOf: - $ref: '#/components/schemas/DateTimeFormatEnum' description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' date_show_tzinfo: type: boolean description: Indicates if the timezone should be shown. date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 required: - database_id - field_constraints - id - immutable_properties - immutable_type - order - read_only - related_fields - table_id - type - workspace_id SingleSelectFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' select_options: type: array items: $ref: '#/components/schemas/SelectOption' single_select_default: type: integer nullable: true PatchedFieldUpdateField: oneOf: - $ref: '#/components/schemas/TextFieldUpdateField' - $ref: '#/components/schemas/LongTextFieldUpdateField' - $ref: '#/components/schemas/URLFieldUpdateField' - $ref: '#/components/schemas/EmailFieldUpdateField' - $ref: '#/components/schemas/NumberFieldUpdateField' - $ref: '#/components/schemas/RatingFieldUpdateField' - $ref: '#/components/schemas/BooleanFieldUpdateField' - $ref: '#/components/schemas/DateFieldUpdateField' - $ref: '#/components/schemas/LastModifiedFieldUpdateField' - $ref: '#/components/schemas/LastModifiedByFieldUpdateField' - $ref: '#/components/schemas/CreatedOnFieldUpdateField' - $ref: '#/components/schemas/CreatedByFieldUpdateField' - $ref: '#/components/schemas/DurationFieldUpdateField' - $ref: '#/components/schemas/LinkRowFieldUpdateField' - $ref: '#/components/schemas/FileFieldUpdateField' - $ref: '#/components/schemas/SingleSelectFieldUpdateField' - $ref: '#/components/schemas/MultipleSelectFieldUpdateField' - $ref: '#/components/schemas/PhoneNumberFieldUpdateField' - $ref: '#/components/schemas/FormulaFieldUpdateField' - $ref: '#/components/schemas/CountFieldUpdateField' - $ref: '#/components/schemas/RollupFieldUpdateField' - $ref: '#/components/schemas/LookupFieldUpdateField' - $ref: '#/components/schemas/MultipleCollaboratorsFieldUpdateField' - $ref: '#/components/schemas/UUIDFieldUpdateField' - $ref: '#/components/schemas/AutonumberFieldUpdateField' - $ref: '#/components/schemas/PasswordFieldUpdateField' - $ref: '#/components/schemas/FormViewEditRowFieldUpdateField' - $ref: '#/components/schemas/AIFieldUpdateField' discriminator: propertyName: type mapping: text: '#/components/schemas/TextFieldUpdateField' long_text: '#/components/schemas/LongTextFieldUpdateField' url: '#/components/schemas/URLFieldUpdateField' email: '#/components/schemas/EmailFieldUpdateField' number: '#/components/schemas/NumberFieldUpdateField' rating: '#/components/schemas/RatingFieldUpdateField' boolean: '#/components/schemas/BooleanFieldUpdateField' date: '#/components/schemas/DateFieldUpdateField' last_modified: '#/components/schemas/LastModifiedFieldUpdateField' last_modified_by: '#/components/schemas/LastModifiedByFieldUpdateField' created_on: '#/components/schemas/CreatedOnFieldUpdateField' created_by: '#/components/schemas/CreatedByFieldUpdateField' duration: '#/components/schemas/DurationFieldUpdateField' link_row: '#/components/schemas/LinkRowFieldUpdateField' file: '#/components/schemas/FileFieldUpdateField' single_select: '#/components/schemas/SingleSelectFieldUpdateField' multiple_select: '#/components/schemas/MultipleSelectFieldUpdateField' phone_number: '#/components/schemas/PhoneNumberFieldUpdateField' formula: '#/components/schemas/FormulaFieldUpdateField' count: '#/components/schemas/CountFieldUpdateField' rollup: '#/components/schemas/RollupFieldUpdateField' lookup: '#/components/schemas/LookupFieldUpdateField' multiple_collaborators: '#/components/schemas/MultipleCollaboratorsFieldUpdateField' uuid: '#/components/schemas/UUIDFieldUpdateField' autonumber: '#/components/schemas/AutonumberFieldUpdateField' password: '#/components/schemas/PasswordFieldUpdateField' form_view_edit_row: '#/components/schemas/FormViewEditRowFieldUpdateField' ai: '#/components/schemas/AIFieldUpdateField' RollupFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. number_suffix: type: string description: The suffix to use for the field. maxLength: 10 number_decimal_places: nullable: true description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' - $ref: '#/components/schemas/NullEnum' array_formula_type: nullable: true oneOf: - $ref: '#/components/schemas/ArrayFormulaTypeEnum' - $ref: '#/components/schemas/NullEnum' duration_format: nullable: true description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' oneOf: - $ref: '#/components/schemas/DurationFormatEnum' - $ref: '#/components/schemas/NullEnum' error: type: string nullable: true date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 select_options: type: array items: $ref: '#/components/schemas/SelectOption' readOnly: true nullable: true date_format: nullable: true description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' oneOf: - $ref: '#/components/schemas/DateFormatEnum' - $ref: '#/components/schemas/NullEnum' nullable: type: boolean readOnly: true date_time_format: nullable: true description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' oneOf: - $ref: '#/components/schemas/DateTimeFormatEnum' - $ref: '#/components/schemas/NullEnum' number_negative: type: boolean readOnly: true default: true available_collaborators: type: array items: $ref: '#/components/schemas/Collaborator' readOnly: true nullable: true description: A list of all the available collaborators. date_show_tzinfo: type: boolean nullable: true description: Indicates if the time zone should be shown. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' date_include_time: type: boolean nullable: true description: Indicates if the field also includes a time. through_field_id: type: integer nullable: true description: The id of the link row field to rollup values for. target_field_id: type: integer nullable: true description: The id of the field in the table linked to by the through_field to rollup. rollup_function: type: string description: The rollup formula function that must be applied. maxLength: 64 formula_type: $ref: '#/components/schemas/FormulaTypeEnum' required: - available_collaborators - database_id - field_constraints - id - immutable_properties - immutable_type - name - nullable - number_negative - order - read_only - related_fields - select_options - table_id - type - workspace_id LongTextFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. long_text_enable_rich_text: type: boolean nullable: true description: Enable rich text formatting for the field. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id AIFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. select_options: type: array items: $ref: '#/components/schemas/SelectOption' ai_generative_ai_type: type: string nullable: true maxLength: 32 ai_generative_ai_model: type: string nullable: true maxLength: 128 ai_output_type: allOf: - $ref: '#/components/schemas/AiOutputTypeE9fEnum' description: 'The desired output type of the field. It will try to force the response of the prompt to match it. * `text` - text * `choice` - choice' ai_temperature: type: number format: double maximum: 2 minimum: 0 nullable: true description: Between 0 and 2, adjusts response randomness—lower values yield focused answers, while higher values increase creativity. ai_prompt: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The prompt that must run for each row. Must be an formula. ai_file_field_id: type: integer minimum: 1 nullable: true description: File field that will be used as a knowledge base for the AI model. ai_auto_update: type: boolean nullable: true default: false description: If set, AI field will be recalculated if a value of a referenced field has been changed. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id AIFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. select_options: type: array items: $ref: '#/components/schemas/SelectOption' ai_generative_ai_type: type: string nullable: true maxLength: 32 ai_generative_ai_model: type: string nullable: true maxLength: 128 ai_output_type: allOf: - $ref: '#/components/schemas/AiOutputTypeE9fEnum' description: 'The desired output type of the field. It will try to force the response of the prompt to match it. * `text` - text * `choice` - choice' ai_temperature: type: number format: double maximum: 2 minimum: 0 nullable: true description: Between 0 and 2, adjusts response randomness—lower values yield focused answers, while higher values increase creativity. ai_prompt: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The prompt that must run for each row. Must be an formula. ai_file_field_id: type: integer minimum: 1 nullable: true description: File field that will be used as a knowledge base for the AI model. ai_auto_update: type: boolean nullable: true default: false description: If set, AI field will be recalculated if a value of a referenced field has been changed. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id SingleSelectFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. select_options: type: array items: $ref: '#/components/schemas/SelectOption' single_select_default: type: integer nullable: true required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id CreatedOnFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. date_format: allOf: - $ref: '#/components/schemas/DateFormatEnum' description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' date_include_time: type: boolean description: Indicates if the field also includes a time. date_time_format: allOf: - $ref: '#/components/schemas/DateTimeFormatEnum' description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' date_show_tzinfo: type: boolean description: Indicates if the timezone should be shown. date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id FormulaFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' number_suffix: type: string description: The suffix to use for the field. maxLength: 10 number_decimal_places: nullable: true description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' - $ref: '#/components/schemas/NullEnum' array_formula_type: nullable: true oneOf: - $ref: '#/components/schemas/ArrayFormulaTypeEnum' - $ref: '#/components/schemas/NullEnum' duration_format: nullable: true description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' oneOf: - $ref: '#/components/schemas/DurationFormatEnum' - $ref: '#/components/schemas/NullEnum' error: type: string readOnly: true date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 date_format: nullable: true description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' oneOf: - $ref: '#/components/schemas/DateFormatEnum' - $ref: '#/components/schemas/NullEnum' nullable: type: boolean readOnly: true date_time_format: nullable: true description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' oneOf: - $ref: '#/components/schemas/DateTimeFormatEnum' - $ref: '#/components/schemas/NullEnum' date_show_tzinfo: type: boolean nullable: true description: Indicates if the time zone should be shown. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' date_include_time: type: boolean nullable: true description: Indicates if the field also includes a time. formula: type: string formula_type: $ref: '#/components/schemas/FormulaTypeEnum' required: - error - formula - nullable LongTextFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' long_text_enable_rich_text: type: boolean nullable: true description: Enable rich text formatting for the field. required: - name - type PhoneNumberFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' MultipleCollaboratorsFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' notify_user_when_added: type: boolean LookupFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' number_suffix: type: string description: The suffix to use for the field. maxLength: 10 number_decimal_places: nullable: true description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' - $ref: '#/components/schemas/NullEnum' array_formula_type: nullable: true oneOf: - $ref: '#/components/schemas/ArrayFormulaTypeEnum' - $ref: '#/components/schemas/NullEnum' duration_format: nullable: true description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' oneOf: - $ref: '#/components/schemas/DurationFormatEnum' - $ref: '#/components/schemas/NullEnum' error: type: string readOnly: true date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 date_format: nullable: true description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' oneOf: - $ref: '#/components/schemas/DateFormatEnum' - $ref: '#/components/schemas/NullEnum' nullable: type: boolean readOnly: true date_time_format: nullable: true description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' oneOf: - $ref: '#/components/schemas/DateTimeFormatEnum' - $ref: '#/components/schemas/NullEnum' date_show_tzinfo: type: boolean nullable: true description: Indicates if the time zone should be shown. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' date_include_time: type: boolean nullable: true description: Indicates if the field also includes a time. through_field_id: type: integer nullable: true description: The id of the link row field to lookup values for. Will override the `through_field_name` parameter if both are provided, however only one is required. through_field_name: type: string nullable: true description: The name of the link row field to lookup values for. target_field_id: type: integer nullable: true description: The id of the field in the table linked to by the through_field to lookup. Will override the `target_field_id` parameter if both are provided, however only one is required. target_field_name: type: string nullable: true description: The name of the field in the table linked to by the through_field to lookup. formula_type: $ref: '#/components/schemas/FormulaTypeEnum' required: - error - nullable CreatedByFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' UUIDFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id RatingFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' max_value: type: integer maximum: 10 minimum: 1 description: Maximum value the rating can take. color: type: string description: Color of the symbols. maxLength: 50 style: allOf: - $ref: '#/components/schemas/StyleEnum' description: 'Rating style. Allowed values: star, heart, thumbs-up, flag, smile. * `star` - Star * `heart` - Heart * `thumbs-up` - Thumbs Up * `flag` - Flag * `smile` - Smile' MultipleSelectFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' select_options: type: array items: $ref: '#/components/schemas/SelectOption' multiple_select_default: type: array items: type: integer nullable: true StyleEnum: enum: - star - heart - thumbs-up - flag - smile type: string description: '* `star` - Star * `heart` - Heart * `thumbs-up` - Thumbs Up * `flag` - Flag * `smile` - Smile' UUIDFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' required: - name - type FormViewEditRowFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' form_view_id: type: integer nullable: true description: The id of the form view used to edit rows via this field. FieldConstraint: type: object properties: type_name: type: string description: The type name of the constraint. maxLength: 255 required: - type_name LastModifiedFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' date_format: allOf: - $ref: '#/components/schemas/DateFormatEnum' description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' date_include_time: type: boolean description: Indicates if the field also includes a time. date_time_format: allOf: - $ref: '#/components/schemas/DateTimeFormatEnum' description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' date_show_tzinfo: type: boolean description: Indicates if the timezone should be shown. date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 date_force_timezone_offset: type: integer nullable: true description: ('A UTC offset in minutes to add to all the field datetimes values.',) required: - type PhoneNumberFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id EmailFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id RollupFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' number_suffix: type: string description: The suffix to use for the field. maxLength: 10 number_decimal_places: nullable: true description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' - $ref: '#/components/schemas/NullEnum' array_formula_type: nullable: true oneOf: - $ref: '#/components/schemas/ArrayFormulaTypeEnum' - $ref: '#/components/schemas/NullEnum' duration_format: nullable: true description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' oneOf: - $ref: '#/components/schemas/DurationFormatEnum' - $ref: '#/components/schemas/NullEnum' error: type: string nullable: true date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 date_format: nullable: true description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' oneOf: - $ref: '#/components/schemas/DateFormatEnum' - $ref: '#/components/schemas/NullEnum' nullable: type: boolean readOnly: true date_time_format: nullable: true description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' oneOf: - $ref: '#/components/schemas/DateTimeFormatEnum' - $ref: '#/components/schemas/NullEnum' date_show_tzinfo: type: boolean nullable: true description: Indicates if the time zone should be shown. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' date_include_time: type: boolean nullable: true description: Indicates if the field also includes a time. through_field_id: type: integer nullable: true description: The id of the link row field to rollup values for. target_field_id: type: integer nullable: true description: The id of the field in the table linked to by the through_field to rollup. rollup_function: type: string description: The rollup formula function that must be applied. maxLength: 64 formula_type: $ref: '#/components/schemas/FormulaTypeEnum' required: - name - nullable - type CountFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' number_suffix: type: string description: The suffix to use for the field. maxLength: 10 number_decimal_places: nullable: true description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' - $ref: '#/components/schemas/NullEnum' array_formula_type: nullable: true oneOf: - $ref: '#/components/schemas/ArrayFormulaTypeEnum' - $ref: '#/components/schemas/NullEnum' duration_format: nullable: true description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' oneOf: - $ref: '#/components/schemas/DurationFormatEnum' - $ref: '#/components/schemas/NullEnum' error: type: string nullable: true date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 date_format: nullable: true description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' oneOf: - $ref: '#/components/schemas/DateFormatEnum' - $ref: '#/components/schemas/NullEnum' nullable: type: boolean readOnly: true date_time_format: nullable: true description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' oneOf: - $ref: '#/components/schemas/DateTimeFormatEnum' - $ref: '#/components/schemas/NullEnum' date_show_tzinfo: type: boolean nullable: true description: Indicates if the time zone should be shown. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' date_include_time: type: boolean nullable: true description: Indicates if the field also includes a time. through_field_id: type: integer nullable: true description: The id of the link row field to count values for. formula_type: $ref: '#/components/schemas/FormulaTypeEnum' required: - nullable MultipleSelectFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. select_options: type: array items: $ref: '#/components/schemas/SelectOption' multiple_select_default: type: array items: type: integer nullable: true required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id FormViewEditRowFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' form_view_id: type: integer nullable: true description: The id of the form view used to edit rows via this field. required: - name - type LinkRowFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' link_row_table_id: type: integer nullable: true description: The id of the linked table. link_row_table: type: integer nullable: true description: (Deprecated) The id of the linked table. has_related_field: type: boolean link_row_limit_selection_view_id: type: integer nullable: true default: -1 description: The ID of the view in the related table where row selection must be limited to. link_row_multiple_relationships: type: boolean description: Indicates whether it's allowed set multiple relationships per row. If disabled, it doesn't guarantee single relationships because they could have already existed or created through reversed relationship. PasswordFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. allow_endpoint_authentication: type: boolean description: If true, then it's possible to use the `password_field_authentication` API endpoint to check if the password is correct. This can be used to use Baserow as authentication backend. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id RollupFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' number_suffix: type: string description: The suffix to use for the field. maxLength: 10 number_decimal_places: nullable: true description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' - $ref: '#/components/schemas/NullEnum' array_formula_type: nullable: true oneOf: - $ref: '#/components/schemas/ArrayFormulaTypeEnum' - $ref: '#/components/schemas/NullEnum' duration_format: nullable: true description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' oneOf: - $ref: '#/components/schemas/DurationFormatEnum' - $ref: '#/components/schemas/NullEnum' error: type: string nullable: true date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 date_format: nullable: true description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' oneOf: - $ref: '#/components/schemas/DateFormatEnum' - $ref: '#/components/schemas/NullEnum' nullable: type: boolean readOnly: true date_time_format: nullable: true description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' oneOf: - $ref: '#/components/schemas/DateTimeFormatEnum' - $ref: '#/components/schemas/NullEnum' date_show_tzinfo: type: boolean nullable: true description: Indicates if the time zone should be shown. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' date_include_time: type: boolean nullable: true description: Indicates if the field also includes a time. through_field_id: type: integer nullable: true description: The id of the link row field to rollup values for. target_field_id: type: integer nullable: true description: The id of the field in the table linked to by the through_field to rollup. rollup_function: type: string description: The rollup formula function that must be applied. maxLength: 64 formula_type: $ref: '#/components/schemas/FormulaTypeEnum' required: - nullable PasswordFieldAuthenticationResponse: type: object properties: is_correct: type: boolean description: Indicates whether the provided password is correct. required: - is_correct EmailFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' NumberFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' number_decimal_places: allOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 number_negative: type: boolean description: Indicates if negative values are allowed. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_suffix: type: string description: The suffix to use for the field. maxLength: 100 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' number_default: type: string format: decimal pattern: ^-?\d{0,30}(?:\.\d{0,20})?$ nullable: true description: The default value for field if none is provided. TextFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. text_default: type: string description: If set, this value is going to be added every time a new row created. maxLength: 255 required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id NumberFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. number_decimal_places: allOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 number_negative: type: boolean description: Indicates if negative values are allowed. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_suffix: type: string description: The suffix to use for the field. maxLength: 100 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' number_default: type: string format: decimal pattern: ^-?\d{0,30}(?:\.\d{0,20})?$ nullable: true description: The default value for field if none is provided. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id URLFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' Field: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id PasswordFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' allow_endpoint_authentication: type: boolean description: If true, then it's possible to use the `password_field_authentication` API endpoint to check if the password is correct. This can be used to use Baserow as authentication backend. required: - name - type LastModifiedByFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' required: - name - type NumberSeparatorEnum: enum: - SPACE_COMMA - SPACE_PERIOD - COMMA_PERIOD - PERIOD_COMMA type: string description: '* `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' TextFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' text_default: type: string description: If set, this value is going to be added every time a new row created. maxLength: 255 required: - name - type PhoneNumberFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' required: - name - type NumberFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. number_decimal_places: allOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 number_negative: type: boolean description: Indicates if negative values are allowed. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_suffix: type: string description: The suffix to use for the field. maxLength: 100 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' number_default: type: string format: decimal pattern: ^-?\d{0,30}(?:\.\d{0,20})?$ nullable: true description: The default value for field if none is provided. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id SelectOption: type: object properties: id: type: integer value: type: string maxLength: 255 color: type: string maxLength: 255 required: - color - value TextFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. text_default: type: string description: If set, this value is going to be added every time a new row created. maxLength: 255 required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id SingleSelectFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. select_options: type: array items: $ref: '#/components/schemas/SelectOption' single_select_default: type: integer nullable: true required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id TypeC3eEnum: enum: - text - long_text - url - email - number - rating - boolean - date - last_modified - last_modified_by - created_on - created_by - duration - link_row - file - single_select - multiple_select - phone_number - formula - count - rollup - lookup - multiple_collaborators - uuid - autonumber - password - form_view_edit_row - ai type: string description: '* `text` - text * `long_text` - long_text * `url` - url * `email` - email * `number` - number * `rating` - rating * `boolean` - boolean * `date` - date * `last_modified` - last_modified * `last_modified_by` - last_modified_by * `created_on` - created_on * `created_by` - created_by * `duration` - duration * `link_row` - link_row * `file` - file * `single_select` - single_select * `multiple_select` - multiple_select * `phone_number` - phone_number * `formula` - formula * `count` - count * `rollup` - rollup * `lookup` - lookup * `multiple_collaborators` - multiple_collaborators * `uuid` - uuid * `autonumber` - autonumber * `password` - password * `form_view_edit_row` - form_view_edit_row * `ai` - ai' FileFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id LastModifiedFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. date_format: allOf: - $ref: '#/components/schemas/DateFormatEnum' description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' date_include_time: type: boolean description: Indicates if the field also includes a time. date_time_format: allOf: - $ref: '#/components/schemas/DateTimeFormatEnum' description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' date_show_tzinfo: type: boolean description: Indicates if the timezone should be shown. date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id RatingFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. max_value: type: integer maximum: 10 minimum: 1 description: Maximum value the rating can take. color: type: string description: Color of the symbols. maxLength: 50 style: allOf: - $ref: '#/components/schemas/StyleEnum' description: 'Rating style. Allowed values: star, heart, thumbs-up, flag, smile. * `star` - Star * `heart` - Heart * `thumbs-up` - Thumbs Up * `flag` - Flag * `smile` - Smile' required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id DurationFormatEnum: enum: - h:mm - h:mm:ss - h:mm:ss.s - h:mm:ss.ss - h:mm:ss.sss - d h - d h:mm - d h:mm:ss - d h mm - d h mm ss type: string description: '* `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' UniqueRowValues: type: object properties: values: type: array items: type: string required: - values URLFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id DurationFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' duration_format: allOf: - $ref: '#/components/schemas/DurationFormatEnum' description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' required: - name - type AutonumberFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id AiOutputTypeE9fEnum: enum: - text - choice type: string description: '* `text` - text * `choice` - choice' CountFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. number_suffix: type: string description: The suffix to use for the field. maxLength: 10 number_decimal_places: nullable: true description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' - $ref: '#/components/schemas/NullEnum' array_formula_type: nullable: true oneOf: - $ref: '#/components/schemas/ArrayFormulaTypeEnum' - $ref: '#/components/schemas/NullEnum' duration_format: nullable: true description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' oneOf: - $ref: '#/components/schemas/DurationFormatEnum' - $ref: '#/components/schemas/NullEnum' error: type: string nullable: true date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 date_format: nullable: true description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' oneOf: - $ref: '#/components/schemas/DateFormatEnum' - $ref: '#/components/schemas/NullEnum' nullable: type: boolean readOnly: true date_time_format: nullable: true description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' oneOf: - $ref: '#/components/schemas/DateTimeFormatEnum' - $ref: '#/components/schemas/NullEnum' date_show_tzinfo: type: boolean nullable: true description: Indicates if the time zone should be shown. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' date_include_time: type: boolean nullable: true description: Indicates if the field also includes a time. through_field_id: type: integer nullable: true description: The id of the link row field to count values for. formula_type: $ref: '#/components/schemas/FormulaTypeEnum' required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - nullable - order - read_only - table_id - type - workspace_id EmailFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' required: - name - type LastModifiedFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' date_format: allOf: - $ref: '#/components/schemas/DateFormatEnum' description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' date_include_time: type: boolean description: Indicates if the field also includes a time. date_time_format: allOf: - $ref: '#/components/schemas/DateTimeFormatEnum' description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' date_show_tzinfo: type: boolean description: Indicates if the timezone should be shown. date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 date_force_timezone_offset: type: integer nullable: true description: ('A UTC offset in minutes to add to all the field datetimes values.',) LongTextFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' long_text_enable_rich_text: type: boolean nullable: true description: Enable rich text formatting for the field. DateFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' date_format: allOf: - $ref: '#/components/schemas/DateFormatEnum' description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' date_include_time: type: boolean description: Indicates if the field also includes a time. date_time_format: allOf: - $ref: '#/components/schemas/DateTimeFormatEnum' description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' date_show_tzinfo: type: boolean description: Indicates if the timezone should be shown. date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 date_force_timezone_offset: type: integer nullable: true description: ('A UTC offset in minutes to add to all the field datetimes values.',) DurationFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. duration_format: allOf: - $ref: '#/components/schemas/DurationFormatEnum' description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id CreatedOnFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' date_format: allOf: - $ref: '#/components/schemas/DateFormatEnum' description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' date_include_time: type: boolean description: Indicates if the field also includes a time. date_time_format: allOf: - $ref: '#/components/schemas/DateTimeFormatEnum' description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' date_show_tzinfo: type: boolean description: Indicates if the timezone should be shown. date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 date_force_timezone_offset: type: integer nullable: true description: ('A UTC offset in minutes to add to all the field datetimes values.',) DateFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. date_format: allOf: - $ref: '#/components/schemas/DateFormatEnum' description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' date_include_time: type: boolean description: Indicates if the field also includes a time. date_time_format: allOf: - $ref: '#/components/schemas/DateTimeFormatEnum' description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' date_show_tzinfo: type: boolean description: Indicates if the timezone should be shown. date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 required: - database_id - field_constraints - id - immutable_properties - immutable_type - order - read_only - related_fields - table_id - type - workspace_id RollupFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. number_suffix: type: string description: The suffix to use for the field. maxLength: 10 number_decimal_places: nullable: true description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' - $ref: '#/components/schemas/NullEnum' array_formula_type: nullable: true oneOf: - $ref: '#/components/schemas/ArrayFormulaTypeEnum' - $ref: '#/components/schemas/NullEnum' duration_format: nullable: true description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' oneOf: - $ref: '#/components/schemas/DurationFormatEnum' - $ref: '#/components/schemas/NullEnum' error: type: string nullable: true date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 select_options: type: array items: $ref: '#/components/schemas/SelectOption' readOnly: true nullable: true date_format: nullable: true description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' oneOf: - $ref: '#/components/schemas/DateFormatEnum' - $ref: '#/components/schemas/NullEnum' nullable: type: boolean readOnly: true date_time_format: nullable: true description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' oneOf: - $ref: '#/components/schemas/DateTimeFormatEnum' - $ref: '#/components/schemas/NullEnum' number_negative: type: boolean readOnly: true default: true available_collaborators: type: array items: $ref: '#/components/schemas/Collaborator' readOnly: true nullable: true description: A list of all the available collaborators. date_show_tzinfo: type: boolean nullable: true description: Indicates if the time zone should be shown. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' date_include_time: type: boolean nullable: true description: Indicates if the field also includes a time. through_field_id: type: integer nullable: true description: The id of the link row field to rollup values for. target_field_id: type: integer nullable: true description: The id of the field in the table linked to by the through_field to rollup. rollup_function: type: string description: The rollup formula function that must be applied. maxLength: 64 formula_type: $ref: '#/components/schemas/FormulaTypeEnum' required: - available_collaborators - database_id - field_constraints - id - immutable_properties - immutable_type - name - nullable - number_negative - order - read_only - select_options - table_id - type - workspace_id URLFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' required: - name - type DateFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' date_format: allOf: - $ref: '#/components/schemas/DateFormatEnum' description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' date_include_time: type: boolean description: Indicates if the field also includes a time. date_time_format: allOf: - $ref: '#/components/schemas/DateTimeFormatEnum' description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' date_show_tzinfo: type: boolean description: Indicates if the timezone should be shown. date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 date_force_timezone_offset: type: integer nullable: true description: ('A UTC offset in minutes to add to all the field datetimes values.',) required: - type DateFormatEnum: enum: - EU - US - ISO type: string description: '* `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' LongTextFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. long_text_enable_rich_text: type: boolean nullable: true description: Enable rich text formatting for the field. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id ChangePrimaryFieldParams: type: object properties: new_primary_field_id: type: integer description: The ID of the new primary field. required: - new_primary_field_id NumberFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' number_decimal_places: allOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 number_negative: type: boolean description: Indicates if negative values are allowed. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_suffix: type: string description: The suffix to use for the field. maxLength: 100 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' number_default: type: string format: decimal pattern: ^-?\d{0,30}(?:\.\d{0,20})?$ nullable: true description: The default value for field if none is provided. required: - name - type LinkRowFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. link_row_table_id: type: integer nullable: true description: The id of the linked table. link_row_related_field_id: type: integer nullable: true description: The id of the related field. readOnly: true link_row_table: type: integer nullable: true description: (Deprecated) The id of the linked table. link_row_related_field: type: integer readOnly: true description: (Deprecated) The id of the related field. link_row_limit_selection_view_id: type: integer nullable: true description: The ID of the view in the related table where row selection must be limited to. link_row_table_primary_field: type: string readOnly: true description: The primary field of the table that is linked to. link_row_multiple_relationships: type: boolean description: Indicates whether it's allowed set multiple relationships per row. If disabled, it doesn't guarantee single relationships because they could have already existed or created through reversed relationship. required: - database_id - field_constraints - id - immutable_properties - immutable_type - link_row_related_field - link_row_related_field_id - link_row_table_primary_field - name - order - read_only - table_id - type - workspace_id LastModifiedByFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. available_collaborators: type: array items: $ref: '#/components/schemas/Collaborator' readOnly: true description: A list of all the available collaborators. required: - available_collaborators - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id FieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id URLFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id CreatedOnFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' date_format: allOf: - $ref: '#/components/schemas/DateFormatEnum' description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' date_include_time: type: boolean description: Indicates if the field also includes a time. date_time_format: allOf: - $ref: '#/components/schemas/DateTimeFormatEnum' description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' date_show_tzinfo: type: boolean description: Indicates if the timezone should be shown. date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 date_force_timezone_offset: type: integer nullable: true description: ('A UTC offset in minutes to add to all the field datetimes values.',) required: - type CountFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. number_suffix: type: string description: The suffix to use for the field. maxLength: 10 number_decimal_places: nullable: true description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' - $ref: '#/components/schemas/NullEnum' array_formula_type: nullable: true oneOf: - $ref: '#/components/schemas/ArrayFormulaTypeEnum' - $ref: '#/components/schemas/NullEnum' duration_format: nullable: true description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' oneOf: - $ref: '#/components/schemas/DurationFormatEnum' - $ref: '#/components/schemas/NullEnum' error: type: string nullable: true date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 date_format: nullable: true description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' oneOf: - $ref: '#/components/schemas/DateFormatEnum' - $ref: '#/components/schemas/NullEnum' nullable: type: boolean readOnly: true date_time_format: nullable: true description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' oneOf: - $ref: '#/components/schemas/DateTimeFormatEnum' - $ref: '#/components/schemas/NullEnum' date_show_tzinfo: type: boolean nullable: true description: Indicates if the time zone should be shown. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' date_include_time: type: boolean nullable: true description: Indicates if the field also includes a time. through_field_id: type: integer nullable: true description: The id of the link row field to count values for. formula_type: $ref: '#/components/schemas/FormulaTypeEnum' required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - nullable - order - read_only - related_fields - table_id - type - workspace_id FormulaFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. number_suffix: type: string description: The suffix to use for the field. maxLength: 10 number_decimal_places: nullable: true description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' - $ref: '#/components/schemas/NullEnum' array_formula_type: nullable: true oneOf: - $ref: '#/components/schemas/ArrayFormulaTypeEnum' - $ref: '#/components/schemas/NullEnum' duration_format: nullable: true description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' oneOf: - $ref: '#/components/schemas/DurationFormatEnum' - $ref: '#/components/schemas/NullEnum' error: type: string readOnly: true date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 select_options: type: array items: $ref: '#/components/schemas/SelectOption' readOnly: true nullable: true date_format: nullable: true description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' oneOf: - $ref: '#/components/schemas/DateFormatEnum' - $ref: '#/components/schemas/NullEnum' nullable: type: boolean readOnly: true date_time_format: nullable: true description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' oneOf: - $ref: '#/components/schemas/DateTimeFormatEnum' - $ref: '#/components/schemas/NullEnum' number_negative: type: boolean readOnly: true default: true available_collaborators: type: array items: $ref: '#/components/schemas/Collaborator' readOnly: true nullable: true description: A list of all the available collaborators. date_show_tzinfo: type: boolean nullable: true description: Indicates if the time zone should be shown. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' date_include_time: type: boolean nullable: true description: Indicates if the field also includes a time. formula: type: string formula_type: $ref: '#/components/schemas/FormulaTypeEnum' required: - available_collaborators - database_id - error - field_constraints - formula - id - immutable_properties - immutable_type - name - nullable - number_negative - order - read_only - select_options - table_id - type - workspace_id GenerateAIFieldValueView: type: object properties: row_ids: type: array items: type: integer description: The ids of the rows that the values should be generated for. maxItems: 200 required: - row_ids AutonumberFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' view_id: type: integer nullable: true description: The id of the view to use for the initial ordering. required: - name - type DurationFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. duration_format: allOf: - $ref: '#/components/schemas/DurationFormatEnum' description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id AutonumberFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id TextFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' text_default: type: string description: If set, this value is going to be added every time a new row created. maxLength: 255 CreatedByFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' required: - name - type BooleanFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. boolean_default: type: boolean description: The default value for field if none is provided. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id FieldFieldSerializerWithRelatedFields: oneOf: - $ref: '#/components/schemas/TextFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/LongTextFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/URLFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/EmailFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/NumberFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/RatingFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/BooleanFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/DateFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/LastModifiedFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/LastModifiedByFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/CreatedOnFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/CreatedByFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/DurationFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/LinkRowFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/FileFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/SingleSelectFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/MultipleSelectFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/PhoneNumberFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/FormulaFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/CountFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/RollupFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/LookupFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/MultipleCollaboratorsFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/UUIDFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/AutonumberFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/PasswordFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/FormViewEditRowFieldFieldSerializerWithRelatedFields' - $ref: '#/components/schemas/AIFieldFieldSerializerWithRelatedFields' discriminator: propertyName: type mapping: text: '#/components/schemas/TextFieldFieldSerializerWithRelatedFields' long_text: '#/components/schemas/LongTextFieldFieldSerializerWithRelatedFields' url: '#/components/schemas/URLFieldFieldSerializerWithRelatedFields' email: '#/components/schemas/EmailFieldFieldSerializerWithRelatedFields' number: '#/components/schemas/NumberFieldFieldSerializerWithRelatedFields' rating: '#/components/schemas/RatingFieldFieldSerializerWithRelatedFields' boolean: '#/components/schemas/BooleanFieldFieldSerializerWithRelatedFields' date: '#/components/schemas/DateFieldFieldSerializerWithRelatedFields' last_modified: '#/components/schemas/LastModifiedFieldFieldSerializerWithRelatedFields' last_modified_by: '#/components/schemas/LastModifiedByFieldFieldSerializerWithRelatedFields' created_on: '#/components/schemas/CreatedOnFieldFieldSerializerWithRelatedFields' created_by: '#/components/schemas/CreatedByFieldFieldSerializerWithRelatedFields' duration: '#/components/schemas/DurationFieldFieldSerializerWithRelatedFields' link_row: '#/components/schemas/LinkRowFieldFieldSerializerWithRelatedFields' file: '#/components/schemas/FileFieldFieldSerializerWithRelatedFields' single_select: '#/components/schemas/SingleSelectFieldFieldSerializerWithRelatedFields' multiple_select: '#/components/schemas/MultipleSelectFieldFieldSerializerWithRelatedFields' phone_number: '#/components/schemas/PhoneNumberFieldFieldSerializerWithRelatedFields' formula: '#/components/schemas/FormulaFieldFieldSerializerWithRelatedFields' count: '#/components/schemas/CountFieldFieldSerializerWithRelatedFields' rollup: '#/components/schemas/RollupFieldFieldSerializerWithRelatedFields' lookup: '#/components/schemas/LookupFieldFieldSerializerWithRelatedFields' multiple_collaborators: '#/components/schemas/MultipleCollaboratorsFieldFieldSerializerWithRelatedFields' uuid: '#/components/schemas/UUIDFieldFieldSerializerWithRelatedFields' autonumber: '#/components/schemas/AutonumberFieldFieldSerializerWithRelatedFields' password: '#/components/schemas/PasswordFieldFieldSerializerWithRelatedFields' form_view_edit_row: '#/components/schemas/FormViewEditRowFieldFieldSerializerWithRelatedFields' ai: '#/components/schemas/AIFieldFieldSerializerWithRelatedFields' MultipleCollaboratorsFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' notify_user_when_added: type: boolean required: - name - type FormViewEditRowFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. form_view_id: type: integer nullable: true description: The id of the form view used to edit rows via this field. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id RatingFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' max_value: type: integer maximum: 10 minimum: 1 description: Maximum value the rating can take. color: type: string description: Color of the symbols. maxLength: 50 style: allOf: - $ref: '#/components/schemas/StyleEnum' description: 'Rating style. Allowed values: star, heart, thumbs-up, flag, smile. * `star` - Star * `heart` - Heart * `thumbs-up` - Thumbs Up * `flag` - Flag * `smile` - Smile' required: - name - type BooleanFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. boolean_default: type: boolean description: The default value for field if none is provided. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id PasswordFieldAuthentication: type: object properties: field_id: type: integer description: The field where to check the password for. row_id: type: integer description: The row where to check the password for. password: type: string description: The password to check. required: - field_id - password - row_id FormViewEditRowFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. form_view_id: type: integer nullable: true description: The id of the form view used to edit rows via this field. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id PasswordFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' allow_endpoint_authentication: type: boolean description: If true, then it's possible to use the `password_field_authentication` API endpoint to check if the password is correct. This can be used to use Baserow as authentication backend. FormulaTypeEnum: enum: - invalid - text - char - button - link - date_interval - duration - date - boolean - number - array - single_select - multiple_select - single_file - url - multiple_collaborators type: string description: '* `invalid` - invalid * `text` - text * `char` - char * `button` - button * `link` - link * `date_interval` - date_interval * `duration` - duration * `date` - date * `boolean` - boolean * `number` - number * `array` - array * `single_select` - single_select * `multiple_select` - multiple_select * `single_file` - single_file * `url` - url * `multiple_collaborators` - multiple_collaborators' LookupFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. number_suffix: type: string description: The suffix to use for the field. maxLength: 10 number_decimal_places: nullable: true description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' - $ref: '#/components/schemas/NullEnum' array_formula_type: nullable: true oneOf: - $ref: '#/components/schemas/ArrayFormulaTypeEnum' - $ref: '#/components/schemas/NullEnum' duration_format: nullable: true description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' oneOf: - $ref: '#/components/schemas/DurationFormatEnum' - $ref: '#/components/schemas/NullEnum' error: type: string readOnly: true date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 select_options: type: array items: $ref: '#/components/schemas/SelectOption' readOnly: true nullable: true date_format: nullable: true description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' oneOf: - $ref: '#/components/schemas/DateFormatEnum' - $ref: '#/components/schemas/NullEnum' nullable: type: boolean readOnly: true date_time_format: nullable: true description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' oneOf: - $ref: '#/components/schemas/DateTimeFormatEnum' - $ref: '#/components/schemas/NullEnum' number_negative: type: boolean readOnly: true default: true available_collaborators: type: array items: $ref: '#/components/schemas/Collaborator' readOnly: true nullable: true description: A list of all the available collaborators. date_show_tzinfo: type: boolean nullable: true description: Indicates if the time zone should be shown. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' date_include_time: type: boolean nullable: true description: Indicates if the field also includes a time. through_field_id: type: integer nullable: true description: The id of the link row field to lookup values for. Will override the `through_field_name` parameter if both are provided, however only one is required. through_field_name: type: string nullable: true description: The name of the link row field to lookup values for. target_field_id: type: integer nullable: true description: The id of the field in the table linked to by the through_field to lookup. Will override the `target_field_id` parameter if both are provided, however only one is required. target_field_name: type: string nullable: true description: The name of the field in the table linked to by the through_field to lookup. formula_type: $ref: '#/components/schemas/FormulaTypeEnum' required: - available_collaborators - database_id - error - field_constraints - id - immutable_properties - immutable_type - name - nullable - number_negative - order - read_only - select_options - table_id - type - workspace_id MultipleSelectFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. select_options: type: array items: $ref: '#/components/schemas/SelectOption' multiple_select_default: type: array items: type: integer nullable: true required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id FieldCreateField: oneOf: - $ref: '#/components/schemas/TextFieldCreateField' - $ref: '#/components/schemas/LongTextFieldCreateField' - $ref: '#/components/schemas/URLFieldCreateField' - $ref: '#/components/schemas/EmailFieldCreateField' - $ref: '#/components/schemas/NumberFieldCreateField' - $ref: '#/components/schemas/RatingFieldCreateField' - $ref: '#/components/schemas/BooleanFieldCreateField' - $ref: '#/components/schemas/DateFieldCreateField' - $ref: '#/components/schemas/LastModifiedFieldCreateField' - $ref: '#/components/schemas/LastModifiedByFieldCreateField' - $ref: '#/components/schemas/CreatedOnFieldCreateField' - $ref: '#/components/schemas/CreatedByFieldCreateField' - $ref: '#/components/schemas/DurationFieldCreateField' - $ref: '#/components/schemas/LinkRowFieldCreateField' - $ref: '#/components/schemas/FileFieldCreateField' - $ref: '#/components/schemas/SingleSelectFieldCreateField' - $ref: '#/components/schemas/MultipleSelectFieldCreateField' - $ref: '#/components/schemas/PhoneNumberFieldCreateField' - $ref: '#/components/schemas/FormulaFieldCreateField' - $ref: '#/components/schemas/CountFieldCreateField' - $ref: '#/components/schemas/RollupFieldCreateField' - $ref: '#/components/schemas/LookupFieldCreateField' - $ref: '#/components/schemas/MultipleCollaboratorsFieldCreateField' - $ref: '#/components/schemas/UUIDFieldCreateField' - $ref: '#/components/schemas/AutonumberFieldCreateField' - $ref: '#/components/schemas/PasswordFieldCreateField' - $ref: '#/components/schemas/FormViewEditRowFieldCreateField' - $ref: '#/components/schemas/AIFieldCreateField' discriminator: propertyName: type mapping: text: '#/components/schemas/TextFieldCreateField' long_text: '#/components/schemas/LongTextFieldCreateField' url: '#/components/schemas/URLFieldCreateField' email: '#/components/schemas/EmailFieldCreateField' number: '#/components/schemas/NumberFieldCreateField' rating: '#/components/schemas/RatingFieldCreateField' boolean: '#/components/schemas/BooleanFieldCreateField' date: '#/components/schemas/DateFieldCreateField' last_modified: '#/components/schemas/LastModifiedFieldCreateField' last_modified_by: '#/components/schemas/LastModifiedByFieldCreateField' created_on: '#/components/schemas/CreatedOnFieldCreateField' created_by: '#/components/schemas/CreatedByFieldCreateField' duration: '#/components/schemas/DurationFieldCreateField' link_row: '#/components/schemas/LinkRowFieldCreateField' file: '#/components/schemas/FileFieldCreateField' single_select: '#/components/schemas/SingleSelectFieldCreateField' multiple_select: '#/components/schemas/MultipleSelectFieldCreateField' phone_number: '#/components/schemas/PhoneNumberFieldCreateField' formula: '#/components/schemas/FormulaFieldCreateField' count: '#/components/schemas/CountFieldCreateField' rollup: '#/components/schemas/RollupFieldCreateField' lookup: '#/components/schemas/LookupFieldCreateField' multiple_collaborators: '#/components/schemas/MultipleCollaboratorsFieldCreateField' uuid: '#/components/schemas/UUIDFieldCreateField' autonumber: '#/components/schemas/AutonumberFieldCreateField' password: '#/components/schemas/PasswordFieldCreateField' form_view_edit_row: '#/components/schemas/FormViewEditRowFieldCreateField' ai: '#/components/schemas/AIFieldCreateField' DurationFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' duration_format: allOf: - $ref: '#/components/schemas/DurationFormatEnum' description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' LinkRowFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' link_row_table_id: type: integer nullable: true description: The id of the linked table. link_row_table: type: integer nullable: true description: (Deprecated) The id of the linked table. has_related_field: type: boolean link_row_limit_selection_view_id: type: integer nullable: true default: -1 description: The ID of the view in the related table where row selection must be limited to. link_row_multiple_relationships: type: boolean description: Indicates whether it's allowed set multiple relationships per row. If disabled, it doesn't guarantee single relationships because they could have already existed or created through reversed relationship. required: - name - type DuplicateFieldJobTypeResponse: type: object properties: id: type: integer readOnly: true type: type: string readOnly: true description: The type of the job. progress_percentage: type: integer description: A percentage indicating how far along the job is. 100 means that it's finished. state: type: string description: Indicates the state of the import job. human_readable_error: type: string description: A human readable error message indicating what went wrong. created_on: type: string format: date-time readOnly: true updated_on: type: string format: date-time readOnly: true original_field: allOf: - $ref: '#/components/schemas/Field' readOnly: true duplicated_field: allOf: - $ref: '#/components/schemas/FieldSerializerWithRelatedFields' readOnly: true required: - created_on - duplicated_field - id - original_field - progress_percentage - state - type - updated_on AIFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' select_options: type: array items: $ref: '#/components/schemas/SelectOption' ai_generative_ai_type: type: string nullable: true maxLength: 32 ai_generative_ai_model: type: string nullable: true maxLength: 128 ai_output_type: allOf: - $ref: '#/components/schemas/AiOutputTypeE9fEnum' description: 'The desired output type of the field. It will try to force the response of the prompt to match it. * `text` - text * `choice` - choice' ai_temperature: type: number format: double maximum: 2 minimum: 0 nullable: true description: Between 0 and 2, adjusts response randomness—lower values yield focused answers, while higher values increase creativity. ai_prompt: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The prompt that must run for each row. Must be an formula. ai_file_field_id: type: integer minimum: 1 nullable: true description: File field that will be used as a knowledge base for the AI model. ai_auto_update: type: boolean nullable: true default: false description: If set, AI field will be recalculated if a value of a referenced field has been changed. AIFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' select_options: type: array items: $ref: '#/components/schemas/SelectOption' ai_generative_ai_type: type: string nullable: true maxLength: 32 ai_generative_ai_model: type: string nullable: true maxLength: 128 ai_output_type: allOf: - $ref: '#/components/schemas/AiOutputTypeE9fEnum' description: 'The desired output type of the field. It will try to force the response of the prompt to match it. * `text` - text * `choice` - choice' ai_temperature: type: number format: double maximum: 2 minimum: 0 nullable: true description: Between 0 and 2, adjusts response randomness—lower values yield focused answers, while higher values increase creativity. ai_prompt: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The prompt that must run for each row. Must be an formula. ai_file_field_id: type: integer minimum: 1 nullable: true description: File field that will be used as a knowledge base for the AI model. ai_auto_update: type: boolean nullable: true default: false description: If set, AI field will be recalculated if a value of a referenced field has been changed. required: - name - type PasswordFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. allow_endpoint_authentication: type: boolean description: If true, then it's possible to use the `password_field_authentication` API endpoint to check if the password is correct. This can be used to use Baserow as authentication backend. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id TypeFormulaResult: type: object properties: number_decimal_places: nullable: true description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' - $ref: '#/components/schemas/NullEnum' duration_format: nullable: true description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' oneOf: - $ref: '#/components/schemas/DurationFormatEnum' - $ref: '#/components/schemas/NullEnum' date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 nullable: type: boolean number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' formula: type: string number_suffix: type: string description: The suffix to use for the field. maxLength: 10 array_formula_type: nullable: true oneOf: - $ref: '#/components/schemas/ArrayFormulaTypeEnum' - $ref: '#/components/schemas/NullEnum' error: type: string nullable: true date_format: nullable: true description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' oneOf: - $ref: '#/components/schemas/DateFormatEnum' - $ref: '#/components/schemas/NullEnum' date_time_format: nullable: true description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' oneOf: - $ref: '#/components/schemas/DateTimeFormatEnum' - $ref: '#/components/schemas/NullEnum' date_show_tzinfo: type: boolean nullable: true description: Indicates if the time zone should be shown. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 date_include_time: type: boolean nullable: true description: Indicates if the field also includes a time. formula_type: $ref: '#/components/schemas/FormulaTypeEnum' required: - formula - nullable MultipleCollaboratorsFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. available_collaborators: type: array items: $ref: '#/components/schemas/Collaborator' readOnly: true description: A list of all the available collaborators. notify_user_when_added: type: boolean required: - available_collaborators - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id Collaborator: type: object properties: id: type: integer name: type: string readOnly: true required: - id - name BlankEnum: enum: - '' UUIDFieldUpdateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' CreatedByFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. available_collaborators: type: array items: $ref: '#/components/schemas/Collaborator' readOnly: true description: A list of all the available collaborators. required: - available_collaborators - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id LinkRowFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. link_row_table_id: type: integer nullable: true description: The id of the linked table. link_row_related_field_id: type: integer nullable: true description: The id of the related field. readOnly: true link_row_table: type: integer nullable: true description: (Deprecated) The id of the linked table. link_row_related_field: type: integer readOnly: true description: (Deprecated) The id of the related field. link_row_limit_selection_view_id: type: integer nullable: true description: The ID of the view in the related table where row selection must be limited to. link_row_table_primary_field: type: string readOnly: true description: The primary field of the table that is linked to. link_row_multiple_relationships: type: boolean description: Indicates whether it's allowed set multiple relationships per row. If disabled, it doesn't guarantee single relationships because they could have already existed or created through reversed relationship. required: - database_id - field_constraints - id - immutable_properties - immutable_type - link_row_related_field - link_row_related_field_id - link_row_table_primary_field - name - order - read_only - related_fields - table_id - type - workspace_id NumberDecimalPlacesEnum: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 type: integer description: '* `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' CountFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' number_suffix: type: string description: The suffix to use for the field. maxLength: 10 number_decimal_places: nullable: true description: 'The amount of digits allowed after the point. * `0` - 1 * `1` - 1.0 * `2` - 1.00 * `3` - 1.000 * `4` - 1.0000 * `5` - 1.00000 * `6` - 1.000000 * `7` - 1.0000000 * `8` - 1.00000000 * `9` - 1.000000000 * `10` - 1.0000000000' minimum: -2147483648 maximum: 2147483647 oneOf: - $ref: '#/components/schemas/NumberDecimalPlacesEnum' - $ref: '#/components/schemas/NullEnum' array_formula_type: nullable: true oneOf: - $ref: '#/components/schemas/ArrayFormulaTypeEnum' - $ref: '#/components/schemas/NullEnum' duration_format: nullable: true description: 'The format of the duration. * `h:mm` - hours:minutes * `h:mm:ss` - hours:minutes:seconds * `h:mm:ss.s` - hours:minutes:seconds:deciseconds * `h:mm:ss.ss` - hours:minutes:seconds:centiseconds * `h:mm:ss.sss` - hours:minutes:seconds:milliseconds * `d h` - days:hours * `d h:mm` - days:hours:minutes * `d h:mm:ss` - days:hours:minutes:seconds * `d h mm` - days:hours:minutes:with_spaces * `d h mm ss` - days:hours:minutes:seconds:with_spaces' oneOf: - $ref: '#/components/schemas/DurationFormatEnum' - $ref: '#/components/schemas/NullEnum' error: type: string nullable: true date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 date_format: nullable: true description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' oneOf: - $ref: '#/components/schemas/DateFormatEnum' - $ref: '#/components/schemas/NullEnum' nullable: type: boolean readOnly: true date_time_format: nullable: true description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' oneOf: - $ref: '#/components/schemas/DateTimeFormatEnum' - $ref: '#/components/schemas/NullEnum' date_show_tzinfo: type: boolean nullable: true description: Indicates if the time zone should be shown. number_prefix: type: string description: The prefix to use for the field. maxLength: 10 number_separator: description: 'The thousand and decimal separator to use for the field. * `` - No formatting * `SPACE_COMMA` - Space, comma * `SPACE_PERIOD` - Space, period * `COMMA_PERIOD` - Comma, period * `PERIOD_COMMA` - Period, comma' oneOf: - $ref: '#/components/schemas/NumberSeparatorEnum' - $ref: '#/components/schemas/BlankEnum' date_include_time: type: boolean nullable: true description: Indicates if the field also includes a time. through_field_id: type: integer nullable: true description: The id of the link row field to count values for. formula_type: $ref: '#/components/schemas/FormulaTypeEnum' required: - name - nullable - type DateFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. date_format: allOf: - $ref: '#/components/schemas/DateFormatEnum' description: 'EU (20/02/2020), US (02/20/2020) or ISO (2020-02-20) * `EU` - European (D/M/Y) * `US` - US (M/D/Y) * `ISO` - ISO (Y-M-D)' date_include_time: type: boolean description: Indicates if the field also includes a time. date_time_format: allOf: - $ref: '#/components/schemas/DateTimeFormatEnum' description: '24 (14:30) or 12 (02:30 PM) * `24` - 24 hour * `12` - 12 hour' date_show_tzinfo: type: boolean description: Indicates if the timezone should be shown. date_force_timezone: type: string nullable: true description: Force a timezone for the field overriding user profile settings. maxLength: 255 required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id FileFieldFieldSerializerWithRelatedFields: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. related_fields: type: array items: $ref: '#/components/schemas/Field' readOnly: true description: A list of related fields which also changed. required: - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - related_fields - table_id - type - workspace_id LastModifiedByFieldField: type: object properties: id: type: integer readOnly: true table_id: type: integer readOnly: true name: type: string maxLength: 255 order: type: integer maximum: 2147483647 minimum: 0 description: Lowest first. type: type: string readOnly: true description: The type of the related field. primary: type: boolean description: Indicates if the field is a primary field. If `true` the field cannot be deleted and the value should represent the whole row. read_only: type: boolean readOnly: true description: Indicates whether the field is a read only field. If true, it's not possible to update the cell value. immutable_type: type: boolean readOnly: true description: Indicates whether the field type is immutable. If true, then it won't be possible to change the field type via the API. immutable_properties: type: boolean readOnly: true description: Indicates whether the field properties are immutable. If true, then it won't be possible to change the properties and the type via the API. description: type: string nullable: true description: Field description database_id: type: integer readOnly: true description: The ID of the database this field belongs to. workspace_id: type: integer readOnly: true description: The ID of the workspace this field belongs to. db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: string readOnly: true description: The constraints applied to this field. available_collaborators: type: array items: $ref: '#/components/schemas/Collaborator' readOnly: true description: A list of all the available collaborators. required: - available_collaborators - database_id - field_constraints - id - immutable_properties - immutable_type - name - order - read_only - table_id - type - workspace_id MultipleSelectFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' select_options: type: array items: $ref: '#/components/schemas/SelectOption' multiple_select_default: type: array items: type: integer nullable: true required: - name - type FileFieldCreateField: type: object properties: name: type: string maxLength: 255 type: $ref: '#/components/schemas/TypeC3eEnum' description: type: string nullable: true description: Field description db_index: type: boolean description: If true, then an index will be added to the Baserow field to increase lookup and filter speed. Note that this comes at a performance cost when creating the row and updating the cell. field_constraints: type: array items: $ref: '#/components/schemas/FieldConstraint' required: - name - type securitySchemes: Database token: type: http scheme: bearer bearerFormat: Token your_token JWT: type: http scheme: bearer bearerFormat: JWT your_token UserSource JWT: type: http scheme: bearer bearerFormat: JWT your_token