openapi: 3.0.3 info: title: Baserow API spec Admin Builder workflow actions 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: Builder workflow actions paths: /api/builder/domains/published/page/{page_id}/workflow_actions/: get: operationId: list_public_builder_page_workflow_actions description: Lists all the workflow actions with their public accessible data. Some configuration might be omitted for security reasons such as passwords or PII. parameters: - in: path name: page_id schema: type: integer description: Returns only the public workflow actions of the page related to the provided Id. required: true tags: - Builder workflow actions security: - UserSource JWT: [] - JWT: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/public_Builder_Workflow_Action_TypeBuilderWorkflowAction' description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_PAGE_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/builder/page/{page_id}/workflow_actions/: get: operationId: list_builder_page_workflow_actions description: Lists all the workflow actions of the page related to the provided parameter if the user has access to the related builder's workspace. If the workspace is related to a template, then this endpoint will be publicly accessible. parameters: - in: path name: page_id schema: type: integer description: Returns only the workflow actions of the page related to the provided Id. required: true tags: - Builder workflow actions security: - UserSource JWT: [] - JWT: [] - {} responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Builder_Workflow_Action_TypeBuilderWorkflowAction' description: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_PAGE_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_builder_page_workflow_action description: Creates a new builder workflow action 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: path name: page_id schema: type: integer description: Creates a workflow action for the builder page related to the provided value. required: true tags: - Builder workflow actions requestBody: content: application/json: schema: $ref: '#/components/schemas/Builder_Workflow_Action_TypeCreateBuilderWorkflowAction' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Builder_Workflow_Action_TypeCreateBuilderWorkflowAction' multipart/form-data: schema: $ref: '#/components/schemas/Builder_Workflow_Action_TypeCreateBuilderWorkflowAction' security: - UserSource JWT: [] - JWT: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Builder_Workflow_Action_TypeBuilderWorkflowAction' 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: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_PAGE_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/builder/page/{page_id}/workflow_actions/order/: post: operationId: order_builder_workflow_actions description: Apply a new order to the workflow actions of a page 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: path name: page_id schema: type: integer description: The page the workflow actions belong to required: true tags: - Builder workflow actions requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderWorkflowActions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/OrderWorkflowActions' multipart/form-data: schema: $ref: '#/components/schemas/OrderWorkflowActions' required: true security: - UserSource JWT: [] - JWT: [] responses: '204': description: No response body '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 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_PAGE_DOES_NOT_EXIST - ERROR_WORKFLOW_ACTION_DOES_NOT_EXIST - ERROR_WORKFLOW_ACTION_NOT_IN_ELEMENT 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/builder/workflow_action/{workflow_action_id}/: patch: operationId: update_builder_page_workflow_action description: Updates an existing builder workflow action. 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: path name: workflow_action_id schema: type: integer description: The id of the workflow action required: true tags: - Builder workflow actions requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedBuilder_Workflow_Action_TypeUpdateBuilderWorkflowActions' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedBuilder_Workflow_Action_TypeUpdateBuilderWorkflowActions' multipart/form-data: schema: $ref: '#/components/schemas/PatchedBuilder_Workflow_Action_TypeUpdateBuilderWorkflowActions' security: - UserSource JWT: [] - JWT: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Builder_Workflow_Action_TypeBuilderWorkflowAction' 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: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_WORKFLOW_ACTION_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_builder_page_workflow_action description: Deletes the workflow action related by the given id. 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: path name: workflow_action_id schema: type: integer description: The id of the workflow action required: true tags: - Builder workflow actions security: - UserSource JWT: [] - JWT: [] responses: '204': description: No response body '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: '' '404': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_WORKFLOW_ACTION_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/builder/workflow_action/{workflow_action_id}/dispatch/: post: operationId: dispatch_builder_page_workflow_action description: Dispatches the service of the related workflow_action and returns the result. 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: path name: workflow_action_id schema: type: integer description: The id of the workflow_action you want to call the dispatch for. required: true tags: - Builder workflow actions security: - UserSource JWT: [] - JWT: [] - {} responses: '400': content: application/json: schema: type: object properties: error: type: string description: Machine readable error indicating what went wrong. enum: - ERROR_WORKFLOW_ACTION_CANNOT_BE_DISPATCHED 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: LocalBaserowUpdateRowWorkflowActionBuilderWorkflowAction: type: object description: Basic builder workflow action serializer properties: id: type: integer readOnly: true order: type: integer maximum: 2147483647 minimum: 0 element_id: type: integer nullable: true readOnly: true type: type: string readOnly: true description: The type of the workflow action event: type: string description: The event that triggers the execution maxLength: 60 service: allOf: - $ref: '#/components/schemas/Integration_ServiceService' description: The service which this workflow action is associated with. required: - element_id - event - id - order - service - type CorePeriodicServiceBasePolymorphicRequest: type: object properties: id: type: integer readOnly: true interval: allOf: - $ref: '#/components/schemas/Interval3bdEnum' description: 'The interval frequency for running the service. * `MINUTE` - MINUTE * `HOUR` - HOUR * `DAY` - DAY * `WEEK` - WEEK * `MONTH` - MONTH' minute: type: integer maximum: 59 minimum: 0 nullable: true description: The minute of the hour when to run (0-59). Required for hourly, daily, weekly, monthly intervals. hour: type: integer maximum: 23 minimum: 0 nullable: true description: The hour of the day when to run (0-23). Required for daily, weekly, monthly intervals. day_of_week: type: integer maximum: 6 minimum: 0 nullable: true description: The day of the week when to run (0=Monday, 6=Sunday). Required for weekly intervals. day_of_month: type: integer maximum: 31 minimum: 1 nullable: true description: The day of the month when to run (1-31). Required for monthly intervals. next_run_at: type: string format: date-time nullable: true description: The next scheduled time for this service to run. Automatically calculated based on the interval and schedule fields. required: - id - interval ButtonTextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' ButtonWidthEnum: enum: - auto - full type: string description: '* `auto` - Auto * `full` - Full' CoreIteratorServiceBasePolymorphicRequest: type: object properties: id: type: integer readOnly: true source: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The path of the array. required: - id Heading6FontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' LocalBaserowRowsDeletedBasePolymorphicRequest: type: object properties: id: type: integer readOnly: true table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. integration_id: type: integer nullable: true description: The id of the Baserow integration we want the data for. required: - id CoreSMTPEmailWorkflowActionUpdateBuilderWorkflowActions: type: object properties: type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' service: allOf: - $ref: '#/components/schemas/Integration_ServiceBasePolymorphicRequest' description: The service which this workflow action is associated with. HTTPFormData: type: object description: Serializer for the Form data model. properties: id: type: integer readOnly: true key: type: string maxLength: 255 value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple required: - id - key LocalBaserowGetRowBasePolymorphicRequest: type: object description: 'A serializer mixin for services which implement the local Baserow filterable mixin. It ensures that when serialize the service, *all* filters (including those pointing to trashed fields) are serialized.' properties: id: type: integer readOnly: true table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. integration_id: type: integer nullable: true description: The id of the Baserow integration we want the data for. view_id: type: integer nullable: true description: The id of the Baserow view we want the data for. filter_type: allOf: - $ref: '#/components/schemas/ConditionTypeEnum' description: 'Indicates whether all the rows should apply to all filters (AND) or to any filter (OR). * `AND` - And * `OR` - Or' search_query: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Any search queries to apply to the service when it is dispatched. row_id: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: A formula for defining the intended row. required: - id CustomCode: type: object properties: css: type: string description: Custom CSS code. js: type: string description: Custom JavaScript code. SlackWriteMessageWorkflowActionBuilderWorkflowAction: type: object description: Basic builder workflow action serializer properties: id: type: integer readOnly: true order: type: integer maximum: 2147483647 minimum: 0 element_id: type: integer nullable: true readOnly: true type: type: string readOnly: true description: The type of the workflow action event: type: string description: The event that triggers the execution maxLength: 60 service: allOf: - $ref: '#/components/schemas/Integration_ServiceService' description: The service which this workflow action is associated with. required: - element_id - event - id - order - service - type LocalBaserowRowsDeletedService: type: object description: Basic service serializer mostly for returned values. properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The id of the Baserow integration we want the data for. type: type: string readOnly: true description: The type of the service. schema: type: object additionalProperties: {} readOnly: true description: The schema of the service. context_data: type: object additionalProperties: {} readOnly: true description: The context data of the service. context_data_schema: type: object additionalProperties: {} readOnly: true description: The schema context data of the service. sample_data: readOnly: true nullable: true description: Store the sample data used for generating a schema. table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. required: - context_data - context_data_schema - id - sample_data - schema - type CoreSMTPEmailWorkflowActionBuilderWorkflowAction: type: object description: Basic builder workflow action serializer properties: id: type: integer readOnly: true order: type: integer maximum: 2147483647 minimum: 0 element_id: type: integer nullable: true readOnly: true type: type: string readOnly: true description: The type of the workflow action event: type: string description: The event that triggers the execution maxLength: 60 service: allOf: - $ref: '#/components/schemas/Integration_ServiceService' description: The service which this workflow action is associated with. required: - element_id - event - id - order - service - type OpenPageWorkflowActionUpdateBuilderWorkflowActions: type: object properties: type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' navigation_type: allOf: - $ref: '#/components/schemas/NavigationTypeEnum' default: page description: 'The navigation type. * `page` - Page * `custom` - Custom' navigate_to_page_id: type: integer nullable: true description: ('Destination page id for this link. If null then we use the navigate_to_url property instead.',) navigate_to_url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: If no page is selected, this indicate the destination of the link. page_parameters: type: array items: $ref: '#/components/schemas/PageParameterValue' default: [] description: The parameters for each parameters of the selected page if any. query_parameters: type: array items: $ref: '#/components/schemas/PageParameterValue' default: [] description: The query parameters for each parameter of the selected page if any. target: allOf: - $ref: '#/components/schemas/TargetEnum' default: self description: 'The target of the link when we click on it. * `self` - Self * `blank` - Blank' Heading5TextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' NotificationWorkflowActionUpdateBuilderWorkflowActions: type: object properties: type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' title: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The title of the notification. Must be an formula. description: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The description of the notification. Must be an formula. OrderWorkflowActions: type: object properties: workflow_action_ids: type: array items: type: integer description: The ids of the workflow actions in the order they are supposed to be set in element_id: type: integer description: The element the workflow actions belong to required: - workflow_action_ids App_Auth_ProviderAppAuthProvider: oneOf: - $ref: '#/components/schemas/LocalBaserowPasswordAppAuthProviderAppAuthProvider' - $ref: '#/components/schemas/SamlAppAuthProviderModelAppAuthProvider' - $ref: '#/components/schemas/OpenIdConnectAppAuthProviderModelAppAuthProvider' discriminator: propertyName: type mapping: local_baserow_password: '#/components/schemas/LocalBaserowPasswordAppAuthProviderAppAuthProvider' saml: '#/components/schemas/SamlAppAuthProviderModelAppAuthProvider' openid_connect: '#/components/schemas/OpenIdConnectAppAuthProviderModelAppAuthProvider' Heading6TextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' SlackWriteMessageWorkflowActionUpdateBuilderWorkflowActions: type: object properties: type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' service: allOf: - $ref: '#/components/schemas/Integration_ServiceBasePolymorphicRequest' description: The service which this workflow action is associated with. CoreSMTPEmailServiceService: type: object description: Basic service serializer mostly for returned values. properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The id of the SMTP integration. type: type: string readOnly: true description: The type of the service. schema: type: object additionalProperties: {} readOnly: true description: The schema of the service. context_data: type: object additionalProperties: {} readOnly: true description: The context data of the service. context_data_schema: type: object additionalProperties: {} readOnly: true description: The schema context data of the service. sample_data: readOnly: true nullable: true description: Store the sample data used for generating a schema. use_instance_smtp_settings: type: boolean default: false description: Whether to use the instance-level Django SMTP configuration. instance_smtp_settings_enabled: type: boolean readOnly: true description: Whether the instance SMTP configuration can be used and should be the default option in the UI. from_email: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The sender's email address. from_name: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The sender's name. to_emails: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Comma-separated list of recipient email addresses. cc_emails: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Comma-separated list of CC email addresses. bcc_emails: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Comma-separated list of BCC email addresses. subject: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The email subject. body_type: allOf: - $ref: '#/components/schemas/BodyTypeD6eEnum' default: plain description: 'The type of the email body (plain text or HTML). * `plain` - Plain Text * `html` - HTML' body: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The email body content. required: - context_data - context_data_schema - id - instance_smtp_settings_enabled - sample_data - schema - type public_Builder_Workflow_Action_TypeBuilderWorkflowAction: oneOf: - $ref: '#/components/schemas/PublicNone' - $ref: '#/components/schemas/PublicNone' - $ref: '#/components/schemas/PublicNone' - $ref: '#/components/schemas/PublicNone' - $ref: '#/components/schemas/PublicNone' - $ref: '#/components/schemas/PublicNone' - $ref: '#/components/schemas/PublicNone' - $ref: '#/components/schemas/PublicNone' - $ref: '#/components/schemas/PublicNone' - $ref: '#/components/schemas/PublicNone' - $ref: '#/components/schemas/PublicNone' discriminator: propertyName: type mapping: public_notification: '#/components/schemas/PublicNone' public_open_page: '#/components/schemas/PublicNone' public_create_row: '#/components/schemas/PublicNone' public_update_row: '#/components/schemas/PublicNone' public_delete_row: '#/components/schemas/PublicNone' public_logout: '#/components/schemas/PublicNone' public_refresh_data_source: '#/components/schemas/PublicNone' public_http_request: '#/components/schemas/PublicNone' public_smtp_email: '#/components/schemas/PublicNone' public_ai_agent: '#/components/schemas/PublicNone' public_slack_write_message: '#/components/schemas/PublicNone' Heading3FontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' Builder_Workflow_Action_TypeCreateBuilderWorkflowAction: oneOf: - $ref: '#/components/schemas/NotificationWorkflowActionCreateBuilderWorkflowAction' - $ref: '#/components/schemas/OpenPageWorkflowActionCreateBuilderWorkflowAction' - $ref: '#/components/schemas/LocalBaserowCreateRowWorkflowActionCreateBuilderWorkflowAction' - $ref: '#/components/schemas/LocalBaserowUpdateRowWorkflowActionCreateBuilderWorkflowAction' - $ref: '#/components/schemas/LocalBaserowDeleteRowWorkflowActionCreateBuilderWorkflowAction' - $ref: '#/components/schemas/LogoutWorkflowActionCreateBuilderWorkflowAction' - $ref: '#/components/schemas/RefreshDataSourceWorkflowActionCreateBuilderWorkflowAction' - $ref: '#/components/schemas/CoreHTTPRequestWorkflowActionCreateBuilderWorkflowAction' - $ref: '#/components/schemas/CoreSMTPEmailWorkflowActionCreateBuilderWorkflowAction' - $ref: '#/components/schemas/AIAgentWorkflowActionCreateBuilderWorkflowAction' - $ref: '#/components/schemas/SlackWriteMessageWorkflowActionCreateBuilderWorkflowAction' discriminator: propertyName: type mapping: notification: '#/components/schemas/NotificationWorkflowActionCreateBuilderWorkflowAction' open_page: '#/components/schemas/OpenPageWorkflowActionCreateBuilderWorkflowAction' create_row: '#/components/schemas/LocalBaserowCreateRowWorkflowActionCreateBuilderWorkflowAction' update_row: '#/components/schemas/LocalBaserowUpdateRowWorkflowActionCreateBuilderWorkflowAction' delete_row: '#/components/schemas/LocalBaserowDeleteRowWorkflowActionCreateBuilderWorkflowAction' logout: '#/components/schemas/LogoutWorkflowActionCreateBuilderWorkflowAction' refresh_data_source: '#/components/schemas/RefreshDataSourceWorkflowActionCreateBuilderWorkflowAction' http_request: '#/components/schemas/CoreHTTPRequestWorkflowActionCreateBuilderWorkflowAction' smtp_email: '#/components/schemas/CoreSMTPEmailWorkflowActionCreateBuilderWorkflowAction' ai_agent: '#/components/schemas/AIAgentWorkflowActionCreateBuilderWorkflowAction' slack_write_message: '#/components/schemas/SlackWriteMessageWorkflowActionCreateBuilderWorkflowAction' LocalBaserowUpdateRowWorkflowActionCreateBuilderWorkflowAction: type: object properties: id: type: integer readOnly: true element_id: type: integer nullable: true description: The id of the element the workflow action is associated with type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' event: type: string description: The event that triggers the execution maxLength: 60 service: allOf: - $ref: '#/components/schemas/Integration_ServiceBasePolymorphicRequest' description: The service which this workflow action is associated with. required: - event - id - type TypeC70Enum: enum: - text - numeric type: string description: '* `text` - text * `numeric` - numeric' Integration_ServiceBasePolymorphicRequest: anyOf: - $ref: '#/components/schemas/LocalBaserowGetRowBasePolymorphicRequest' - $ref: '#/components/schemas/LocalBaserowListRowsBasePolymorphicRequest' - $ref: '#/components/schemas/LocalBaserowAggregateRowsBasePolymorphicRequest' - $ref: '#/components/schemas/LocalBaserowUpsertRowBasePolymorphicRequest' - $ref: '#/components/schemas/LocalBaserowDeleteRowBasePolymorphicRequest' - $ref: '#/components/schemas/LocalBaserowRowsCreatedBasePolymorphicRequest' - $ref: '#/components/schemas/LocalBaserowRowsUpdatedBasePolymorphicRequest' - $ref: '#/components/schemas/LocalBaserowRowsDeletedBasePolymorphicRequest' - $ref: '#/components/schemas/SlackWriteMessageServiceBasePolymorphicRequest' - $ref: '#/components/schemas/CoreHTTPRequestServiceBasePolymorphicRequest' - $ref: '#/components/schemas/CoreSMTPEmailServiceBasePolymorphicRequest' - $ref: '#/components/schemas/CoreRouterServiceBasePolymorphicRequest' - $ref: '#/components/schemas/CoreHTTPTriggerServiceBasePolymorphicRequest' - $ref: '#/components/schemas/CoreIteratorServiceBasePolymorphicRequest' - $ref: '#/components/schemas/CorePeriodicServiceBasePolymorphicRequest' - $ref: '#/components/schemas/AIAgentServiceBasePolymorphicRequest' - $ref: '#/components/schemas/LocalBaserowGroupedAggregateRowsBasePolymorphicRequest' LocalBaserowCreateRowWorkflowActionUpdateBuilderWorkflowActions: type: object properties: type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' service: allOf: - $ref: '#/components/schemas/Integration_ServiceBasePolymorphicRequest' description: The service which this workflow action is associated with. ImageAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' RefreshDataSourceWorkflowActionCreateBuilderWorkflowAction: type: object properties: id: type: integer readOnly: true element_id: type: integer nullable: true description: The id of the element the workflow action is associated with type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' event: type: string description: The event that triggers the execution maxLength: 60 data_source_id: type: integer nullable: true description: The ID of the Data Source to be refreshed. required: - event - id - type CoreSMTPEmailWorkflowActionCreateBuilderWorkflowAction: type: object properties: id: type: integer readOnly: true element_id: type: integer nullable: true description: The id of the element the workflow action is associated with type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' event: type: string description: The event that triggers the execution maxLength: 60 service: allOf: - $ref: '#/components/schemas/Integration_ServiceBasePolymorphicRequest' description: The service which this workflow action is associated with. required: - event - id - type ImageConstraintEnum: enum: - cover - contain - full-width type: string description: '* `cover` - Cover * `contain` - Contain * `full-width` - Full Width' ButtonFontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' LinkTextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' RefreshDataSourceWorkflowActionBuilderWorkflowAction: type: object description: Basic builder workflow action serializer properties: id: type: integer readOnly: true order: type: integer maximum: 2147483647 minimum: 0 element_id: type: integer nullable: true readOnly: true type: type: string readOnly: true description: The type of the workflow action event: type: string description: The event that triggers the execution maxLength: 60 data_source_id: type: integer nullable: true description: The ID of the Data Source to be refreshed. required: - element_id - event - id - order - type LoadTypeEnum: enum: - defer - async type: string description: '* `` - None * `defer` - Defer * `async` - Async' AIAgentWorkflowActionBuilderWorkflowAction: type: object description: Basic builder workflow action serializer properties: id: type: integer readOnly: true order: type: integer maximum: 2147483647 minimum: 0 element_id: type: integer nullable: true readOnly: true type: type: string readOnly: true description: The type of the workflow action event: type: string description: The event that triggers the execution maxLength: 60 service: allOf: - $ref: '#/components/schemas/Integration_ServiceService' description: The service which this workflow action is associated with. required: - element_id - event - id - order - service - type LogoutWorkflowActionCreateBuilderWorkflowAction: type: object properties: id: type: integer readOnly: true element_id: type: integer nullable: true description: The id of the element the workflow action is associated with type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' event: type: string description: The event that triggers the execution maxLength: 60 required: - event - id - type AIAgentWorkflowActionUpdateBuilderWorkflowActions: type: object properties: type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' service: allOf: - $ref: '#/components/schemas/Integration_ServiceBasePolymorphicRequest' description: The service which this workflow action is associated with. Heading5FontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' CoreHTTPRequestWorkflowActionCreateBuilderWorkflowAction: type: object properties: id: type: integer readOnly: true element_id: type: integer nullable: true description: The id of the element the workflow action is associated with type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' event: type: string description: The event that triggers the execution maxLength: 60 service: allOf: - $ref: '#/components/schemas/Integration_ServiceBasePolymorphicRequest' description: The service which this workflow action is associated with. required: - event - id - type Interval3bdEnum: enum: - MINUTE - HOUR - DAY - WEEK - MONTH type: string description: '* `MINUTE` - MINUTE * `HOUR` - HOUR * `DAY` - DAY * `WEEK` - WEEK * `MONTH` - MONTH' Heading3TextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' User_SourceBasePublicUserSource: oneOf: - $ref: '#/components/schemas/LocalBaserowUserSourceBasePublicUserSource' discriminator: propertyName: type mapping: local_baserow: '#/components/schemas/LocalBaserowUserSourceBasePublicUserSource' CrossoriginEnum: enum: - anonymous - credentials type: string description: '* `` - None * `anonymous` - Anonymous * `credentials` - Use credentials' LocalBaserowListRowsService: type: object description: 'A serializer mixin for services which implement the local Baserow filterable mixin. It ensures that when serialize the service, *all* filters (including those pointing to trashed fields) are serialized.' properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The id of the Baserow integration we want the data for. type: type: string readOnly: true description: The type of the service. schema: type: object additionalProperties: {} readOnly: true description: The schema of the service. context_data: type: object additionalProperties: {} readOnly: true description: The context data of the service. context_data_schema: type: object additionalProperties: {} readOnly: true description: The schema context data of the service. sample_data: readOnly: true nullable: true description: Store the sample data used for generating a schema. table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. view_id: type: integer nullable: true description: The id of the Baserow view we want the data for. filter_type: allOf: - $ref: '#/components/schemas/ConditionTypeEnum' description: 'Indicates whether all the rows should apply to all filters (AND) or to any filter (OR). * `AND` - And * `OR` - Or' search_query: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Any search queries to apply to the service when it is dispatched. default_result_count: type: integer maximum: 2147483647 minimum: 0 description: The default record count returned with each page. required: - context_data - context_data_schema - id - sample_data - schema - type BodyTypeD6eEnum: enum: - plain - html type: string description: '* `plain` - Plain Text * `html` - HTML' PatchedBuilder_Workflow_Action_TypeUpdateBuilderWorkflowActions: anyOf: - $ref: '#/components/schemas/NotificationWorkflowActionUpdateBuilderWorkflowActions' - $ref: '#/components/schemas/OpenPageWorkflowActionUpdateBuilderWorkflowActions' - $ref: '#/components/schemas/LocalBaserowCreateRowWorkflowActionUpdateBuilderWorkflowActions' - $ref: '#/components/schemas/LocalBaserowUpdateRowWorkflowActionUpdateBuilderWorkflowActions' - $ref: '#/components/schemas/LocalBaserowDeleteRowWorkflowActionUpdateBuilderWorkflowActions' - $ref: '#/components/schemas/LogoutWorkflowActionUpdateBuilderWorkflowActions' - $ref: '#/components/schemas/RefreshDataSourceWorkflowActionUpdateBuilderWorkflowActions' - $ref: '#/components/schemas/CoreHTTPRequestWorkflowActionUpdateBuilderWorkflowActions' - $ref: '#/components/schemas/CoreSMTPEmailWorkflowActionUpdateBuilderWorkflowActions' - $ref: '#/components/schemas/AIAgentWorkflowActionUpdateBuilderWorkflowActions' - $ref: '#/components/schemas/SlackWriteMessageWorkflowActionUpdateBuilderWorkflowActions' Type292Enum: enum: - notification - open_page - create_row - update_row - delete_row - logout - refresh_data_source - http_request - smtp_email - ai_agent - slack_write_message type: string description: '* `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' LocalBaserowDeleteRowWorkflowActionUpdateBuilderWorkflowActions: type: object properties: type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' service: allOf: - $ref: '#/components/schemas/Integration_ServiceBasePolymorphicRequest' description: The service which this workflow action is associated with. SlackWriteMessageServiceService: type: object description: Basic service serializer mostly for returned values. properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The id of the Slack bot integration. type: type: string readOnly: true description: The type of the service. schema: type: object additionalProperties: {} readOnly: true description: The schema of the service. context_data: type: object additionalProperties: {} readOnly: true description: The context data of the service. context_data_schema: type: object additionalProperties: {} readOnly: true description: The schema context data of the service. sample_data: readOnly: true nullable: true description: Store the sample data used for generating a schema. channel: type: string default: '' description: The Slack channel ID where the message will be sent. text: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text content of the Slack message. required: - context_data - context_data_schema - id - sample_data - schema - type LocalBaserowDeleteRowWorkflowActionCreateBuilderWorkflowAction: type: object properties: id: type: integer readOnly: true element_id: type: integer nullable: true description: The id of the element the workflow action is associated with type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' event: type: string description: The event that triggers the execution maxLength: 60 service: allOf: - $ref: '#/components/schemas/Integration_ServiceBasePolymorphicRequest' description: The service which this workflow action is associated with. required: - event - id - type PageParameterValue: type: object properties: name: type: string value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple required: - name DirectionEnum: enum: - ASC - DESC type: string description: '* `ASC` - Ascending * `DESC` - Descending' VisibilityC5fEnum: enum: - all - logged-in type: string description: '* `all` - All * `logged-in` - Logged In' SlackWriteMessageServiceBasePolymorphicRequest: type: object properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The id of the Slack bot integration. channel: type: string default: '' description: The Slack channel ID where the message will be sent. text: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The text content of the Slack message. required: - id RefreshDataSourceWorkflowActionUpdateBuilderWorkflowActions: type: object properties: type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' data_source_id: type: integer nullable: true description: The ID of the Data Source to be refreshed. CorePeriodicServiceService: type: object description: Basic service serializer mostly for returned values. properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The integration used to establish the connection with the service. readOnly: true type: type: string readOnly: true description: The type of the service. schema: type: object additionalProperties: {} readOnly: true description: The schema of the service. context_data: type: object additionalProperties: {} readOnly: true description: The context data of the service. context_data_schema: type: object additionalProperties: {} readOnly: true description: The schema context data of the service. sample_data: readOnly: true nullable: true description: Store the sample data used for generating a schema. interval: allOf: - $ref: '#/components/schemas/Interval3bdEnum' description: 'The interval frequency for running the service. * `MINUTE` - MINUTE * `HOUR` - HOUR * `DAY` - DAY * `WEEK` - WEEK * `MONTH` - MONTH' minute: type: integer maximum: 59 minimum: 0 nullable: true description: The minute of the hour when to run (0-59). Required for hourly, daily, weekly, monthly intervals. hour: type: integer maximum: 23 minimum: 0 nullable: true description: The hour of the day when to run (0-23). Required for daily, weekly, monthly intervals. day_of_week: type: integer maximum: 6 minimum: 0 nullable: true description: The day of the week when to run (0=Monday, 6=Sunday). Required for weekly intervals. day_of_month: type: integer maximum: 31 minimum: 1 nullable: true description: The day of the month when to run (1-31). Required for monthly intervals. next_run_at: type: string format: date-time nullable: true description: The next scheduled time for this service to run. Automatically calculated based on the interval and schedule fields. required: - context_data - context_data_schema - id - integration_id - interval - sample_data - schema - type CoreRouterServiceEdge: type: object properties: uid: type: string format: uuid label: type: string description: The label to apply next to router edge. maxLength: 75 order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. condition: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple required: - order AIAgentServiceService: type: object description: Basic service serializer mostly for returned values. properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The ID of the AI integration to use for this service. type: type: string readOnly: true description: The type of the service. schema: type: object additionalProperties: {} readOnly: true description: The schema of the service. context_data: type: object additionalProperties: {} readOnly: true description: The context data of the service. context_data_schema: type: object additionalProperties: {} readOnly: true description: The schema context data of the service. sample_data: readOnly: true nullable: true description: Store the sample data used for generating a schema. ai_generative_ai_type: type: string nullable: true description: The generative AI provider type (e.g., 'openai', 'anthropic'). ai_generative_ai_model: type: string nullable: true description: The specific AI model to use (e.g., 'gpt-4', 'claude-3-opus'). ai_output_type: allOf: - $ref: '#/components/schemas/AiOutputType5efEnum' default: text description: 'The output type: ''text'' for raw text, ''choice'' for constrained selection. * `text` - Text * `choice` - Choice' ai_temperature: type: number format: double maximum: 2 minimum: 0 nullable: true description: Temperature for response randomness (0-2). Lower is more focused. ai_prompt: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The prompt to send to the AI model. Can be a formula. ai_choices: type: array items: type: string description: List of choice options for 'choice' output type. required: - context_data - context_data_schema - id - sample_data - schema - type RoleTypeEnum: enum: - allow_all - allow_all_except - disallow_all_except type: string description: '* `allow_all` - Allow All * `allow_all_except` - Allow All Except * `disallow_all_except` - Disallow All Except' LocalBaserowUpsertRowService: type: object description: Basic service serializer mostly for returned values. properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The id of the Baserow integration we want the data for. type: type: string readOnly: true description: The type of the service. schema: type: object additionalProperties: {} readOnly: true description: The schema of the service. context_data: type: object additionalProperties: {} readOnly: true description: The context data of the service. context_data_schema: type: object additionalProperties: {} readOnly: true description: The schema context data of the service. sample_data: readOnly: true nullable: true description: Store the sample data used for generating a schema. table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. field_mappings: type: array items: $ref: '#/components/schemas/LocalBaserowTableServiceFieldMapping' description: The field mapping associated with this service. row_id: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: A formula for defining the intended row. required: - context_data - context_data_schema - id - sample_data - schema - type NotificationWorkflowActionBuilderWorkflowAction: type: object description: Basic builder workflow action serializer properties: id: type: integer readOnly: true order: type: integer maximum: 2147483647 minimum: 0 element_id: type: integer nullable: true readOnly: true type: type: string readOnly: true description: The type of the workflow action event: type: string description: The event that triggers the execution maxLength: 60 title: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The title of the notification. Must be an formula. description: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The description of the notification. Must be an formula. required: - element_id - event - id - order - type SortOnEnum: enum: - SERIES - GROUP_BY - PRIMARY type: string description: '* `SERIES` - Series * `GROUP_BY` - Group by * `PRIMARY` - Primary' ButtonAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' LocalBaserowRowsUpdatedService: type: object description: Basic service serializer mostly for returned values. properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The id of the Baserow integration we want the data for. type: type: string readOnly: true description: The type of the service. schema: type: object additionalProperties: {} readOnly: true description: The schema of the service. context_data: type: object additionalProperties: {} readOnly: true description: The context data of the service. context_data_schema: type: object additionalProperties: {} readOnly: true description: The schema context data of the service. sample_data: readOnly: true nullable: true description: Store the sample data used for generating a schema. table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. required: - context_data - context_data_schema - id - sample_data - schema - type LabelFontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' ConditionTypeEnum: enum: - AND - OR type: string description: '* `AND` - And * `OR` - Or' CoreHTTPTriggerServiceBasePolymorphicRequest: type: object properties: id: type: integer readOnly: true uid: type: string format: uuid description: The service identifier for the webhook. exclude_get: type: boolean description: Whether the service should exclude GET requests for added security. By default all HTTP methods listed in the API endpoint are supported. required: - id LocalBaserowUpsertRowBasePolymorphicRequest: type: object properties: id: type: integer readOnly: true table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. integration_id: type: integer nullable: true description: The id of the Baserow integration we want the data for. field_mappings: type: array items: $ref: '#/components/schemas/LocalBaserowTableServiceFieldMapping' description: The field mapping associated with this service. row_id: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: A formula for defining the intended row. required: - id PublicNone: type: object description: Change the workspace to add licences. properties: id: type: integer readOnly: true name: type: string maxLength: 160 order: type: integer maximum: 2147483647 minimum: 0 type: type: string readOnly: true workspace: type: string readOnly: true created_on: type: string format: date-time readOnly: true favicon_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The favicon image file login_page_id: type: integer nullable: true description: The login page for this application. This is related to the visibility settings of builder pages. pages: type: array items: $ref: '#/components/schemas/PublicPage' readOnly: true description: This field is specific to the `builder` application and contains an array of pages that are in the builder. theme: allOf: - $ref: '#/components/schemas/ColorTypographyButtonImagePageInputTableLinklink_active_text_decoration' readOnly: true description: This field is specific to the `builder` application and contains the theme settings. user_sources: type: array items: $ref: '#/components/schemas/User_SourceBasePublicUserSource' readOnly: true description: The user sources related with this builder. scripts: type: array items: $ref: '#/components/schemas/CustomScript' readOnly: true description: Scripts to embed for this application custom_code: allOf: - $ref: '#/components/schemas/CustomCode' description: Custom CSS/JS code for this builder required: - created_on - custom_code - id - name - order - pages - scripts - theme - type - user_sources - workspace LocalBaserowDeleteRowBasePolymorphicRequest: type: object properties: id: type: integer readOnly: true table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. integration_id: type: integer nullable: true description: The id of the Baserow integration we want the data for. row_id: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: A formula for defining the intended row. required: - id LocalBaserowRowsCreatedBasePolymorphicRequest: type: object properties: id: type: integer readOnly: true table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. integration_id: type: integer nullable: true description: The id of the Baserow integration we want the data for. required: - id OpenIdConnectAppAuthProviderModelAppAuthProvider: type: object description: Basic app_auth_provider serializer mostly for returned values. properties: type: type: string readOnly: true description: The type of the app_auth_provider. id: type: integer readOnly: true domain: type: string nullable: true description: The email domain registered with this provider. maxLength: 255 name: type: string maxLength: 255 base_url: type: string description: The provider base url. client_id: type: string description: App ID, or consumer key maxLength: 191 secret: type: string description: API secret, client secret, or consumer secret maxLength: 191 use_id_token: type: boolean description: Whether to use the id_token instead of user_info endpoint to get user data email_attr_key: type: string description: The name of the claim that contains the email address of the user. maxLength: 32 first_name_attr_key: type: string description: The key in the OIDC response that contains the first name of the user. maxLength: 32 last_name_attr_key: type: string description: The key in the OIDC response that contains the last name of the user. If empty in response, first name will be used. maxLength: 32 required: - base_url - client_id - id - name - secret - type CoreRouterServiceService: type: object description: Basic service serializer mostly for returned values. properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The integration used to establish the connection with the service. readOnly: true type: type: string readOnly: true description: The type of the service. schema: type: object additionalProperties: {} readOnly: true description: The schema of the service. context_data: type: object additionalProperties: {} readOnly: true description: The context data of the service. context_data_schema: type: object additionalProperties: {} readOnly: true description: The schema context data of the service. sample_data: readOnly: true nullable: true description: Store the sample data used for generating a schema. default_edge_label: type: string description: The label to apply next to router edge. maxLength: 75 edges: type: array items: $ref: '#/components/schemas/CoreRouterServiceEdge' description: The edges associated with this service. required: - context_data - context_data_schema - id - integration_id - sample_data - schema - type LocalBaserowListRowsBasePolymorphicRequest: type: object description: 'A serializer mixin for services which implement the local Baserow filterable mixin. It ensures that when serialize the service, *all* filters (including those pointing to trashed fields) are serialized.' properties: id: type: integer readOnly: true table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. integration_id: type: integer nullable: true description: The id of the Baserow integration we want the data for. view_id: type: integer nullable: true description: The id of the Baserow view we want the data for. filter_type: allOf: - $ref: '#/components/schemas/ConditionTypeEnum' description: 'Indicates whether all the rows should apply to all filters (AND) or to any filter (OR). * `AND` - And * `OR` - Or' search_query: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Any search queries to apply to the service when it is dispatched. default_result_count: type: integer maximum: 2147483647 minimum: 0 description: The default record count returned with each page. required: - id CoreHTTPRequestServiceService: type: object description: Basic service serializer mostly for returned values. properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The integration used to establish the connection with the service. readOnly: true type: type: string readOnly: true description: The type of the service. schema: type: object additionalProperties: {} readOnly: true description: The schema of the service. context_data: type: object additionalProperties: {} readOnly: true description: The context data of the service. context_data_schema: type: object additionalProperties: {} readOnly: true description: The schema context data of the service. sample_data: readOnly: true nullable: true description: Store the sample data used for generating a schema. http_method: allOf: - $ref: '#/components/schemas/HttpMethodEnum' default: GET description: 'The HTTP method to use for the request (e.g., GET, POST). * `GET` - GET * `POST` - POST * `PUT` - PUT * `DELETE` - DELETE * `PATCH` - PATCH * `HEAD` - HEAD * `OPTIONS` - OPTIONS' url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The URL to which the HTTP request will be sent. headers: type: array items: $ref: '#/components/schemas/HTTPHeader' description: The headers for the request. query_params: type: array items: $ref: '#/components/schemas/HTTPQueryParam' description: The query params for the request. form_data: type: array items: $ref: '#/components/schemas/HTTPFormData' description: The form data for the request. body_type: allOf: - $ref: '#/components/schemas/BodyType870Enum' default: none description: 'The type of the body content (e.g., JSON, Form Data). * `json` - JSON * `form` - Form Data * `raw` - Raw * `none` - None' body_content: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The content of the body of the HTTP request. timeout: type: integer maximum: 120 minimum: 1 description: The timeout for the HTTP request in seconds. required: - context_data - context_data_schema - id - integration_id - sample_data - schema - type CustomScript: type: object properties: id: type: integer readOnly: true type: allOf: - $ref: '#/components/schemas/CustomScriptTypeEnum' description: 'The type of script. * `stylesheet` - Stylesheet * `javascript` - JavaScript' url: type: string format: uri description: The URL of the script. maxLength: 200 load_type: description: 'The load type of the script. * `` - None * `defer` - Defer * `async` - Async' oneOf: - $ref: '#/components/schemas/LoadTypeEnum' - $ref: '#/components/schemas/BlankEnum' crossorigin: description: 'The Crossorigin type of the script. * `` - None * `anonymous` - Anonymous * `credentials` - Use credentials' oneOf: - $ref: '#/components/schemas/CrossoriginEnum' - $ref: '#/components/schemas/BlankEnum' required: - id HTTPHeader: type: object description: Serializer for the HTTPHeader model. properties: id: type: integer readOnly: true key: type: string maxLength: 255 value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple required: - id - key InputFontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' AiOutputType5efEnum: enum: - text - choice type: string description: '* `text` - Text * `choice` - Choice' LocalBaserowTableServiceFieldMapping: type: object properties: field_id: type: integer description: The primary key of the associated database table field. enabled: type: boolean description: Indicates whether the field mapping is enabled or not. value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple required: - enabled - field_id AIAgentWorkflowActionCreateBuilderWorkflowAction: type: object properties: id: type: integer readOnly: true element_id: type: integer nullable: true description: The id of the element the workflow action is associated with type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' event: type: string description: The event that triggers the execution maxLength: 60 service: allOf: - $ref: '#/components/schemas/Integration_ServiceBasePolymorphicRequest' description: The service which this workflow action is associated with. required: - event - id - type TableHeaderTextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' Heading4TextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' NotificationWorkflowActionCreateBuilderWorkflowAction: type: object properties: id: type: integer readOnly: true element_id: type: integer nullable: true description: The id of the element the workflow action is associated with type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' event: type: string description: The event that triggers the execution maxLength: 60 title: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The title of the notification. Must be an formula. description: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The description of the notification. Must be an formula. required: - event - id - type OpenPageWorkflowActionBuilderWorkflowAction: type: object description: Basic builder workflow action serializer properties: id: type: integer readOnly: true order: type: integer maximum: 2147483647 minimum: 0 element_id: type: integer nullable: true readOnly: true type: type: string readOnly: true description: The type of the workflow action event: type: string description: The event that triggers the execution maxLength: 60 navigation_type: allOf: - $ref: '#/components/schemas/NavigationTypeEnum' default: page description: 'The navigation type. * `page` - Page * `custom` - Custom' navigate_to_page_id: type: integer nullable: true description: ('Destination page id for this link. If null then we use the navigate_to_url property instead.',) navigate_to_url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: If no page is selected, this indicate the destination of the link. page_parameters: type: array items: $ref: '#/components/schemas/PageParameterValue' default: [] description: The parameters for each parameters of the selected page if any. query_parameters: type: array items: $ref: '#/components/schemas/PageParameterValue' default: [] description: The query parameters for each parameter of the selected page if any. target: allOf: - $ref: '#/components/schemas/TargetEnum' default: self description: 'The target of the link when we click on it. * `self` - Self * `blank` - Blank' required: - element_id - event - id - order - type BodyType870Enum: enum: - json - form - raw - none type: string description: '* `json` - JSON * `form` - Form Data * `raw` - Raw * `none` - None' LocalBaserowAggregateRowsBasePolymorphicRequest: type: object description: 'A serializer mixin for services which implement the local Baserow filterable mixin. It ensures that when serialize the service, *all* filters (including those pointing to trashed fields) are serialized.' properties: id: type: integer readOnly: true table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. integration_id: type: integer nullable: true description: The id of the Baserow integration we want the data for. view_id: type: integer nullable: true description: The id of the Baserow view we want the data for. filter_type: allOf: - $ref: '#/components/schemas/ConditionTypeEnum' description: 'Indicates whether all the rows should apply to all filters (AND) or to any filter (OR). * `AND` - And * `OR` - Or' search_query: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Any search queries to apply to the service when it is dispatched. field_id: type: integer nullable: true description: The id of the Baserow field we want to aggregate on. aggregation_type: type: string description: The field aggregation type. maxLength: 48 required: - id LocalBaserowAggregateRowsService: type: object description: 'A serializer mixin for services which implement the local Baserow filterable mixin. It ensures that when serialize the service, *all* filters (including those pointing to trashed fields) are serialized.' properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The id of the Baserow integration we want the data for. type: type: string readOnly: true description: The type of the service. schema: type: object additionalProperties: {} readOnly: true description: The schema of the service. context_data: type: object additionalProperties: {} readOnly: true description: The context data of the service. context_data_schema: type: object additionalProperties: {} readOnly: true description: The schema context data of the service. sample_data: readOnly: true nullable: true description: Store the sample data used for generating a schema. table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. view_id: type: integer nullable: true description: The id of the Baserow view we want the data for. filter_type: allOf: - $ref: '#/components/schemas/ConditionTypeEnum' description: 'Indicates whether all the rows should apply to all filters (AND) or to any filter (OR). * `AND` - And * `OR` - Or' search_query: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Any search queries to apply to the service when it is dispatched. field_id: type: integer nullable: true description: The id of the Baserow field we want to aggregate on. aggregation_type: type: string description: The field aggregation type. maxLength: 48 required: - context_data - context_data_schema - id - sample_data - schema - type QueryParam: type: object properties: name: type: string description: The name of the parameter. maxLength: 255 type: allOf: - $ref: '#/components/schemas/TypeC70Enum' description: 'The type of the parameter. * `text` - text * `numeric` - numeric' required: - name - type LocalBaserowCreateRowWorkflowActionBuilderWorkflowAction: type: object description: Basic builder workflow action serializer properties: id: type: integer readOnly: true order: type: integer maximum: 2147483647 minimum: 0 element_id: type: integer nullable: true readOnly: true type: type: string readOnly: true description: The type of the workflow action event: type: string description: The event that triggers the execution maxLength: 60 service: allOf: - $ref: '#/components/schemas/Integration_ServiceService' description: The service which this workflow action is associated with. required: - element_id - event - id - order - service - type LocalBaserowGroupedAggregateRowsBasePolymorphicRequest: type: object description: 'A serializer mixin for services which implement the local Baserow filterable mixin. It ensures that when serialize the service, *all* filters (including those pointing to trashed fields) are serialized.' properties: id: type: integer readOnly: true table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. integration_id: type: integer nullable: true description: The id of the Baserow integration we want the data for. view_id: type: integer nullable: true description: The id of the Baserow view we want the data for. filter_type: allOf: - $ref: '#/components/schemas/ConditionTypeEnum' description: 'Indicates whether all the rows should apply to all filters (AND) or to any filter (OR). * `AND` - And * `OR` - Or' aggregation_series: type: array items: $ref: '#/components/schemas/LocalBaserowTableServiceAggregationSeries' aggregation_group_bys: type: array items: $ref: '#/components/schemas/LocalBaserowTableServiceAggregationGroupBy' aggregation_sorts: type: array items: $ref: '#/components/schemas/LocalBaserowTableServiceAggregationSortBy' required: - id PageBackgroundModeEnum: enum: - tile - fill - fit type: string description: '* `tile` - Tile * `fill` - Fill * `fit` - Fit' LocalBaserowUpdateRowWorkflowActionUpdateBuilderWorkflowActions: type: object properties: type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' service: allOf: - $ref: '#/components/schemas/Integration_ServiceBasePolymorphicRequest' description: The service which this workflow action is associated with. LocalBaserowTableServiceAggregationGroupBy: type: object properties: order: type: integer readOnly: true field_id: type: integer nullable: true required: - field_id - order CoreHTTPRequestWorkflowActionUpdateBuilderWorkflowActions: type: object properties: type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' service: allOf: - $ref: '#/components/schemas/Integration_ServiceBasePolymorphicRequest' description: The service which this workflow action is associated with. HTTPQueryParam: type: object description: Serializer for the HTTPQueryParam model. properties: id: type: integer readOnly: true key: type: string maxLength: 255 value: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple required: - id - key LinkFontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' LocalBaserowDeleteRowService: type: object description: Basic service serializer mostly for returned values. properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The id of the Baserow integration we want the data for. type: type: string readOnly: true description: The type of the service. schema: type: object additionalProperties: {} readOnly: true description: The schema of the service. context_data: type: object additionalProperties: {} readOnly: true description: The context data of the service. context_data_schema: type: object additionalProperties: {} readOnly: true description: The schema context data of the service. sample_data: readOnly: true nullable: true description: Store the sample data used for generating a schema. table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. row_id: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: A formula for defining the intended row. required: - context_data - context_data_schema - id - sample_data - schema - type Heading1TextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' CoreSMTPEmailServiceBasePolymorphicRequest: type: object properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The id of the SMTP integration. use_instance_smtp_settings: type: boolean default: false description: Whether to use the instance-level Django SMTP configuration. instance_smtp_settings_enabled: type: boolean readOnly: true description: Whether the instance SMTP configuration can be used and should be the default option in the UI. from_email: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The sender's email address. from_name: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The sender's name. to_emails: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Comma-separated list of recipient email addresses. cc_emails: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Comma-separated list of CC email addresses. bcc_emails: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Comma-separated list of BCC email addresses. subject: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The email subject. body_type: allOf: - $ref: '#/components/schemas/BodyTypeD6eEnum' default: plain description: 'The type of the email body (plain text or HTML). * `plain` - Plain Text * `html` - HTML' body: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The email body content. required: - id - instance_smtp_settings_enabled HttpMethodEnum: enum: - GET - POST - PUT - DELETE - PATCH - HEAD - OPTIONS type: string description: '* `GET` - GET * `POST` - POST * `PUT` - PUT * `DELETE` - DELETE * `PATCH` - PATCH * `HEAD` - HEAD * `OPTIONS` - OPTIONS' LogoutWorkflowActionBuilderWorkflowAction: type: object description: Basic builder workflow action serializer properties: id: type: integer readOnly: true order: type: integer maximum: 2147483647 minimum: 0 element_id: type: integer nullable: true readOnly: true type: type: string readOnly: true description: The type of the workflow action event: type: string description: The event that triggers the execution maxLength: 60 required: - element_id - event - id - order - type LocalBaserowRowsCreatedService: type: object description: Basic service serializer mostly for returned values. properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The id of the Baserow integration we want the data for. type: type: string readOnly: true description: The type of the service. schema: type: object additionalProperties: {} readOnly: true description: The schema of the service. context_data: type: object additionalProperties: {} readOnly: true description: The context data of the service. context_data_schema: type: object additionalProperties: {} readOnly: true description: The schema context data of the service. sample_data: readOnly: true nullable: true description: Store the sample data used for generating a schema. table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. required: - context_data - context_data_schema - id - sample_data - schema - type TargetEnum: enum: - self - blank type: string description: '* `self` - Self * `blank` - Blank' LocalBaserowCreateRowWorkflowActionCreateBuilderWorkflowAction: type: object properties: id: type: integer readOnly: true element_id: type: integer nullable: true description: The id of the element the workflow action is associated with type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' event: type: string description: The event that triggers the execution maxLength: 60 service: allOf: - $ref: '#/components/schemas/Integration_ServiceBasePolymorphicRequest' description: The service which this workflow action is associated with. required: - event - id - type ColorTypographyButtonImagePageInputTableLinklink_active_text_decoration: type: object properties: primary_color: type: string maxLength: 255 secondary_color: type: string maxLength: 255 border_color: type: string maxLength: 255 main_success_color: type: string maxLength: 255 main_warning_color: type: string maxLength: 255 main_error_color: type: string maxLength: 255 custom_colors: {} heading_1_text_decoration: type: array items: type: boolean description: 'Text decoration: [underline, stroke, uppercase, italic]' heading_2_text_decoration: type: array items: type: boolean description: 'Text decoration: [underline, stroke, uppercase, italic]' heading_3_text_decoration: type: array items: type: boolean description: 'Text decoration: [underline, stroke, uppercase, italic]' heading_4_text_decoration: type: array items: type: boolean description: 'Text decoration: [underline, stroke, uppercase, italic]' heading_5_text_decoration: type: array items: type: boolean description: 'Text decoration: [underline, stroke, uppercase, italic]' heading_6_text_decoration: type: array items: type: boolean description: 'Text decoration: [underline, stroke, uppercase, italic]' body_font_family: type: string maxLength: 250 body_font_size: type: integer maximum: 32767 minimum: -32768 body_font_weight: $ref: '#/components/schemas/BodyFontWeightEnum' body_text_color: type: string maxLength: 255 body_text_alignment: $ref: '#/components/schemas/BodyTextAlignmentEnum' heading_1_font_family: type: string maxLength: 250 heading_1_font_size: type: integer maximum: 32767 minimum: -32768 heading_1_font_weight: $ref: '#/components/schemas/Heading1FontWeightEnum' heading_1_text_color: type: string maxLength: 255 heading_1_text_alignment: $ref: '#/components/schemas/Heading1TextAlignmentEnum' heading_2_font_family: type: string maxLength: 250 heading_2_font_size: type: integer maximum: 32767 minimum: -32768 heading_2_font_weight: $ref: '#/components/schemas/Heading2FontWeightEnum' heading_2_text_color: type: string maxLength: 255 heading_2_text_alignment: $ref: '#/components/schemas/Heading2TextAlignmentEnum' heading_3_font_family: type: string maxLength: 250 heading_3_font_size: type: integer maximum: 32767 minimum: -32768 heading_3_font_weight: $ref: '#/components/schemas/Heading3FontWeightEnum' heading_3_text_color: type: string maxLength: 255 heading_3_text_alignment: $ref: '#/components/schemas/Heading3TextAlignmentEnum' heading_4_font_family: type: string maxLength: 250 heading_4_font_size: type: integer maximum: 32767 minimum: -32768 heading_4_font_weight: $ref: '#/components/schemas/Heading4FontWeightEnum' heading_4_text_color: type: string maxLength: 255 heading_4_text_alignment: $ref: '#/components/schemas/Heading4TextAlignmentEnum' heading_5_font_family: type: string maxLength: 250 heading_5_font_size: type: integer maximum: 32767 minimum: -32768 heading_5_font_weight: $ref: '#/components/schemas/Heading5FontWeightEnum' heading_5_text_color: type: string maxLength: 255 heading_5_text_alignment: $ref: '#/components/schemas/Heading5TextAlignmentEnum' heading_6_font_family: type: string maxLength: 250 heading_6_font_size: type: integer maximum: 32767 minimum: -32768 heading_6_font_weight: $ref: '#/components/schemas/Heading6FontWeightEnum' heading_6_text_color: type: string maxLength: 255 heading_6_text_alignment: $ref: '#/components/schemas/Heading6TextAlignmentEnum' button_font_family: type: string maxLength: 250 button_font_size: type: integer maximum: 32767 minimum: -32768 button_font_weight: $ref: '#/components/schemas/ButtonFontWeightEnum' button_alignment: $ref: '#/components/schemas/ButtonAlignmentEnum' button_text_alignment: $ref: '#/components/schemas/ButtonTextAlignmentEnum' button_width: $ref: '#/components/schemas/ButtonWidthEnum' button_background_color: type: string description: The background color of buttons maxLength: 255 button_text_color: type: string description: The text color of buttons maxLength: 255 button_border_color: type: string description: The border color of buttons maxLength: 255 button_border_size: type: integer maximum: 32767 minimum: -32768 description: Button border size button_border_radius: type: integer maximum: 32767 minimum: -32768 description: Button border radius button_vertical_padding: type: integer maximum: 32767 minimum: -32768 description: Button vertical padding button_horizontal_padding: type: integer maximum: 32767 minimum: -32768 description: Button horizontal padding button_hover_background_color: type: string description: The background color of buttons when hovered maxLength: 255 button_hover_text_color: type: string description: The text color of buttons when hovered maxLength: 255 button_hover_border_color: type: string description: The border color of buttons when hovered maxLength: 255 button_active_background_color: type: string description: The background color of buttons when active maxLength: 255 button_active_text_color: type: string description: The text color of buttons when active maxLength: 255 button_active_border_color: type: string description: The border color of buttons when active maxLength: 255 image_max_height: type: integer description: The image max height image_alignment: $ref: '#/components/schemas/ImageAlignmentEnum' image_max_width: type: integer maximum: 100 minimum: 0 description: The max-width for this image element. image_border_radius: type: integer maximum: 100 minimum: 0 description: The border radius for this image element. image_constraint: allOf: - $ref: '#/components/schemas/ImageConstraintEnum' description: 'The image constraint to apply to this image * `cover` - Cover * `contain` - Contain * `full-width` - Full Width' page_background_file: allOf: - $ref: '#/components/schemas/UserFile' nullable: true description: The image file page_background_color: type: string description: The background color of the page maxLength: 255 page_background_mode: allOf: - $ref: '#/components/schemas/PageBackgroundModeEnum' description: 'The mode of the background image * `tile` - Tile * `fill` - Fill * `fit` - Fit' label_font_family: type: string description: The font family of the label maxLength: 250 label_text_color: type: string description: The text color of the label maxLength: 255 label_font_size: type: integer maximum: 32767 minimum: -32768 description: The font size of the label label_font_weight: $ref: '#/components/schemas/LabelFontWeightEnum' input_font_family: type: string description: The font family of the input maxLength: 250 input_font_size: type: integer maximum: 32767 minimum: -32768 input_font_weight: $ref: '#/components/schemas/InputFontWeightEnum' input_text_color: type: string description: The text color of the input maxLength: 255 input_background_color: type: string description: The background color of the input maxLength: 255 input_border_color: type: string description: The color of the input border maxLength: 255 input_border_size: type: integer maximum: 32767 minimum: -32768 description: Input border size input_border_radius: type: integer maximum: 32767 minimum: -32768 description: Input border radius input_vertical_padding: type: integer maximum: 32767 minimum: -32768 description: Input vertical padding input_horizontal_padding: type: integer maximum: 32767 minimum: -32768 description: Input horizontal padding table_border_color: type: string description: The color of the table border maxLength: 255 table_border_size: type: integer maximum: 32767 minimum: -32768 description: Table border size table_border_radius: type: integer maximum: 32767 minimum: -32768 description: Table border radius table_header_background_color: type: string description: The background color of the table header cells maxLength: 255 table_header_text_color: type: string description: The text color of the table header cells maxLength: 255 table_header_font_size: type: integer maximum: 32767 minimum: -32768 description: The font size of the header cells table_header_font_weight: $ref: '#/components/schemas/TableHeaderFontWeightEnum' table_header_font_family: type: string description: The font family of the table header cells maxLength: 250 table_header_text_alignment: $ref: '#/components/schemas/TableHeaderTextAlignmentEnum' table_cell_background_color: type: string description: The background color of the table cells maxLength: 255 table_cell_alternate_background_color: type: string description: The alternate background color of the table cells maxLength: 255 table_cell_alignment: $ref: '#/components/schemas/TableCellAlignmentEnum' table_cell_vertical_padding: type: integer maximum: 32767 minimum: -32768 description: Table cell vertical padding table_cell_horizontal_padding: type: integer maximum: 32767 minimum: -32768 description: Table cell horizontal padding table_vertical_separator_color: type: string description: The color of the table vertical separator maxLength: 255 table_vertical_separator_size: type: integer maximum: 32767 minimum: -32768 description: Table vertical separator size table_horizontal_separator_color: type: string description: The color of the table horizontal separator maxLength: 255 table_horizontal_separator_size: type: integer maximum: 32767 minimum: -32768 description: Table horizontal separator size link_default_text_decoration: type: array items: type: boolean description: 'Default text decoration: [underline, stroke, uppercase, italic]' link_hover_text_decoration: type: array items: type: boolean description: 'Hover text decoration: [underline, stroke, uppercase, italic]' link_active_text_decoration: type: array items: type: boolean description: 'Active text decoration: [underline, stroke, uppercase, italic]' link_font_family: type: string maxLength: 250 link_font_size: type: integer maximum: 32767 minimum: -32768 link_font_weight: $ref: '#/components/schemas/LinkFontWeightEnum' link_text_alignment: $ref: '#/components/schemas/LinkTextAlignmentEnum' link_text_color: type: string description: The text color of links maxLength: 255 link_hover_text_color: type: string description: The hover color of links when hovered maxLength: 255 link_active_text_color: type: string description: The hover color of links when active maxLength: 255 Heading2TextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' SamlAppAuthProviderModelAppAuthProvider: type: object description: Basic app_auth_provider serializer mostly for returned values. properties: type: type: string readOnly: true description: The type of the app_auth_provider. id: type: integer readOnly: true domain: type: string nullable: true description: The email domain registered with this provider. maxLength: 255 metadata: type: string description: The SAML metadata XML provided by the IdP. is_verified: type: boolean readOnly: true description: Whether or not a user sign in correctly with this SAML provider. email_attr_key: type: string description: The key in the SAML response that contains the email address of the user. first_name_attr_key: type: string description: The key in the SAML response that contains the first name of the user. last_name_attr_key: type: string description: The key in the SAML response that contains the last name of the user. If this is not set, the first name attr will be used as full name. required: - id - is_verified - metadata - type OpenPageWorkflowActionCreateBuilderWorkflowAction: type: object properties: id: type: integer readOnly: true element_id: type: integer nullable: true description: The id of the element the workflow action is associated with type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' event: type: string description: The event that triggers the execution maxLength: 60 navigation_type: allOf: - $ref: '#/components/schemas/NavigationTypeEnum' default: page description: 'The navigation type. * `page` - Page * `custom` - Custom' navigate_to_page_id: type: integer nullable: true description: ('Destination page id for this link. If null then we use the navigate_to_url property instead.',) navigate_to_url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: If no page is selected, this indicate the destination of the link. page_parameters: type: array items: $ref: '#/components/schemas/PageParameterValue' default: [] description: The parameters for each parameters of the selected page if any. query_parameters: type: array items: $ref: '#/components/schemas/PageParameterValue' default: [] description: The query parameters for each parameter of the selected page if any. target: allOf: - $ref: '#/components/schemas/TargetEnum' default: self description: 'The target of the link when we click on it. * `self` - Self * `blank` - Blank' required: - event - id - type LocalBaserowGroupedAggregateRowsService: type: object description: 'A serializer mixin for services which implement the local Baserow filterable mixin. It ensures that when serialize the service, *all* filters (including those pointing to trashed fields) are serialized.' properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The id of the Baserow integration we want the data for. type: type: string readOnly: true description: The type of the service. schema: type: object additionalProperties: {} readOnly: true description: The schema of the service. context_data: type: object additionalProperties: {} readOnly: true description: The context data of the service. context_data_schema: type: object additionalProperties: {} readOnly: true description: The schema context data of the service. sample_data: readOnly: true nullable: true description: Store the sample data used for generating a schema. table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. view_id: type: integer nullable: true description: The id of the Baserow view we want the data for. filter_type: allOf: - $ref: '#/components/schemas/ConditionTypeEnum' description: 'Indicates whether all the rows should apply to all filters (AND) or to any filter (OR). * `AND` - And * `OR` - Or' aggregation_series: type: array items: $ref: '#/components/schemas/LocalBaserowTableServiceAggregationSeries' aggregation_group_bys: type: array items: $ref: '#/components/schemas/LocalBaserowTableServiceAggregationGroupBy' aggregation_sorts: type: array items: $ref: '#/components/schemas/LocalBaserowTableServiceAggregationSortBy' required: - context_data - context_data_schema - id - sample_data - schema - type Builder_Workflow_Action_TypeBuilderWorkflowAction: oneOf: - $ref: '#/components/schemas/NotificationWorkflowActionBuilderWorkflowAction' - $ref: '#/components/schemas/OpenPageWorkflowActionBuilderWorkflowAction' - $ref: '#/components/schemas/LocalBaserowCreateRowWorkflowActionBuilderWorkflowAction' - $ref: '#/components/schemas/LocalBaserowUpdateRowWorkflowActionBuilderWorkflowAction' - $ref: '#/components/schemas/LocalBaserowDeleteRowWorkflowActionBuilderWorkflowAction' - $ref: '#/components/schemas/LogoutWorkflowActionBuilderWorkflowAction' - $ref: '#/components/schemas/RefreshDataSourceWorkflowActionBuilderWorkflowAction' - $ref: '#/components/schemas/CoreHTTPRequestWorkflowActionBuilderWorkflowAction' - $ref: '#/components/schemas/CoreSMTPEmailWorkflowActionBuilderWorkflowAction' - $ref: '#/components/schemas/AIAgentWorkflowActionBuilderWorkflowAction' - $ref: '#/components/schemas/SlackWriteMessageWorkflowActionBuilderWorkflowAction' discriminator: propertyName: type mapping: notification: '#/components/schemas/NotificationWorkflowActionBuilderWorkflowAction' open_page: '#/components/schemas/OpenPageWorkflowActionBuilderWorkflowAction' create_row: '#/components/schemas/LocalBaserowCreateRowWorkflowActionBuilderWorkflowAction' update_row: '#/components/schemas/LocalBaserowUpdateRowWorkflowActionBuilderWorkflowAction' delete_row: '#/components/schemas/LocalBaserowDeleteRowWorkflowActionBuilderWorkflowAction' logout: '#/components/schemas/LogoutWorkflowActionBuilderWorkflowAction' refresh_data_source: '#/components/schemas/RefreshDataSourceWorkflowActionBuilderWorkflowAction' http_request: '#/components/schemas/CoreHTTPRequestWorkflowActionBuilderWorkflowAction' smtp_email: '#/components/schemas/CoreSMTPEmailWorkflowActionBuilderWorkflowAction' ai_agent: '#/components/schemas/AIAgentWorkflowActionBuilderWorkflowAction' slack_write_message: '#/components/schemas/SlackWriteMessageWorkflowActionBuilderWorkflowAction' CoreHTTPRequestWorkflowActionBuilderWorkflowAction: type: object description: Basic builder workflow action serializer properties: id: type: integer readOnly: true order: type: integer maximum: 2147483647 minimum: 0 element_id: type: integer nullable: true readOnly: true type: type: string readOnly: true description: The type of the workflow action event: type: string description: The event that triggers the execution maxLength: 60 service: allOf: - $ref: '#/components/schemas/Integration_ServiceService' description: The service which this workflow action is associated with. required: - element_id - event - id - order - service - type Heading2FontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' LogoutWorkflowActionUpdateBuilderWorkflowActions: type: object properties: type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' LocalBaserowTableServiceAggregationSortBy: type: object properties: order: type: integer readOnly: true sort_on: $ref: '#/components/schemas/SortOnEnum' reference: type: string maxLength: 255 direction: $ref: '#/components/schemas/DirectionEnum' required: - direction - order - reference - sort_on SlackWriteMessageWorkflowActionCreateBuilderWorkflowAction: type: object properties: id: type: integer readOnly: true element_id: type: integer nullable: true description: The id of the element the workflow action is associated with type: allOf: - $ref: '#/components/schemas/Type292Enum' description: 'The type of the workflow action * `notification` - notification * `open_page` - open_page * `create_row` - create_row * `update_row` - update_row * `delete_row` - delete_row * `logout` - logout * `refresh_data_source` - refresh_data_source * `http_request` - http_request * `smtp_email` - smtp_email * `ai_agent` - ai_agent * `slack_write_message` - slack_write_message' event: type: string description: The event that triggers the execution maxLength: 60 service: allOf: - $ref: '#/components/schemas/Integration_ServiceBasePolymorphicRequest' description: The service which this workflow action is associated with. required: - event - id - type CustomScriptTypeEnum: enum: - stylesheet - javascript type: string description: '* `stylesheet` - Stylesheet * `javascript` - JavaScript' BodyTextAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' PublicPage: type: object description: A public version of the page serializer with less data to prevent data leaks. properties: id: type: integer readOnly: true name: type: string maxLength: 255 path: type: string maxLength: 255 path_params: type: array items: $ref: '#/components/schemas/PathParam' shared: type: boolean visibility: allOf: - $ref: '#/components/schemas/VisibilityC5fEnum' description: 'Controls the page''s visibility. When set to ''logged-in'', the builder''s login_page must also be set. * `all` - All * `logged-in` - Logged In' role_type: allOf: - $ref: '#/components/schemas/RoleTypeEnum' description: 'Role type is used in conjunction with roles to control access to this page. * `allow_all` - Allow All * `allow_all_except` - Allow All Except * `disallow_all_except` - Disallow All Except' roles: description: List of user roles that are associated with this page. Used in conjunction with role_type. query_params: type: array items: $ref: '#/components/schemas/QueryParam' required: - id - name - path CoreRouterServiceBasePolymorphicRequest: type: object properties: id: type: integer readOnly: true default_edge_label: type: string description: The label to apply next to router edge. maxLength: 75 edges: type: array items: $ref: '#/components/schemas/CoreRouterServiceEdge' description: The edges associated with this service. required: - id TableHeaderFontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' LocalBaserowGetRowService: type: object description: 'A serializer mixin for services which implement the local Baserow filterable mixin. It ensures that when serialize the service, *all* filters (including those pointing to trashed fields) are serialized.' properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The id of the Baserow integration we want the data for. type: type: string readOnly: true description: The type of the service. schema: type: object additionalProperties: {} readOnly: true description: The schema of the service. context_data: type: object additionalProperties: {} readOnly: true description: The context data of the service. context_data_schema: type: object additionalProperties: {} readOnly: true description: The schema context data of the service. sample_data: readOnly: true nullable: true description: Store the sample data used for generating a schema. table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. view_id: type: integer nullable: true description: The id of the Baserow view we want the data for. filter_type: allOf: - $ref: '#/components/schemas/ConditionTypeEnum' description: 'Indicates whether all the rows should apply to all filters (AND) or to any filter (OR). * `AND` - And * `OR` - Or' search_query: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: Any search queries to apply to the service when it is dispatched. row_id: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: A formula for defining the intended row. required: - context_data - context_data_schema - id - sample_data - schema - type BodyFontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' LocalBaserowTableServiceAggregationSeries: type: object properties: id: type: integer aggregation_type: type: string description: The field aggregation type. maxLength: 48 field_id: type: integer nullable: true required: - field_id LocalBaserowRowsUpdatedBasePolymorphicRequest: type: object properties: id: type: integer readOnly: true table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. integration_id: type: integer nullable: true description: The id of the Baserow integration we want the data for. required: - id CoreHTTPRequestServiceBasePolymorphicRequest: type: object properties: id: type: integer readOnly: true http_method: allOf: - $ref: '#/components/schemas/HttpMethodEnum' default: GET description: 'The HTTP method to use for the request (e.g., GET, POST). * `GET` - GET * `POST` - POST * `PUT` - PUT * `DELETE` - DELETE * `PATCH` - PATCH * `HEAD` - HEAD * `OPTIONS` - OPTIONS' url: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The URL to which the HTTP request will be sent. headers: type: array items: $ref: '#/components/schemas/HTTPHeader' description: The headers for the request. query_params: type: array items: $ref: '#/components/schemas/HTTPQueryParam' description: The query params for the request. form_data: type: array items: $ref: '#/components/schemas/HTTPFormData' description: The form data for the request. body_type: allOf: - $ref: '#/components/schemas/BodyType870Enum' default: none description: 'The type of the body content (e.g., JSON, Form Data). * `json` - JSON * `form` - Form Data * `raw` - Raw * `none` - None' body_content: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The content of the body of the HTTP request. timeout: type: integer maximum: 120 minimum: 1 description: The timeout for the HTTP request in seconds. required: - id CoreHTTPTriggerServiceService: type: object description: Basic service serializer mostly for returned values. properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The integration used to establish the connection with the service. readOnly: true type: type: string readOnly: true description: The type of the service. schema: type: object additionalProperties: {} readOnly: true description: The schema of the service. context_data: type: object additionalProperties: {} readOnly: true description: The context data of the service. context_data_schema: type: object additionalProperties: {} readOnly: true description: The schema context data of the service. sample_data: readOnly: true nullable: true description: Store the sample data used for generating a schema. uid: type: string format: uuid description: The service identifier for the webhook. exclude_get: type: boolean description: Whether the service should exclude GET requests for added security. By default all HTTP methods listed in the API endpoint are supported. is_public: type: boolean description: Defines whether the service is published or not. required: - context_data - context_data_schema - id - integration_id - sample_data - schema - type UserFile: type: object properties: size: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 mime_type: type: string maxLength: 127 is_image: type: boolean image_width: type: integer maximum: 2147483647 minimum: 0 nullable: true image_height: type: integer maximum: 2147483647 minimum: 0 nullable: true uploaded_at: type: string format: date-time readOnly: true url: type: string format: uri readOnly: true thumbnails: type: object additionalProperties: {} readOnly: true name: type: string readOnly: true original_name: type: string maxLength: 255 required: - name - original_name - size - thumbnails - uploaded_at - url LocalBaserowDeleteRowWorkflowActionBuilderWorkflowAction: type: object description: Basic builder workflow action serializer properties: id: type: integer readOnly: true order: type: integer maximum: 2147483647 minimum: 0 element_id: type: integer nullable: true readOnly: true type: type: string readOnly: true description: The type of the workflow action event: type: string description: The event that triggers the execution maxLength: 60 service: allOf: - $ref: '#/components/schemas/Integration_ServiceService' description: The service which this workflow action is associated with. required: - element_id - event - id - order - service - type Heading4FontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' BlankEnum: enum: - '' LocalBaserowUserSourceBasePublicUserSource: type: object description: Basic user source serializer mostly for returned values. properties: id: type: integer readOnly: true uid: type: string readOnly: true description: Unique id for this user source. type: type: string readOnly: true description: The type of the user_source. name: type: string readOnly: true order: type: string format: decimal pattern: ^-?\d{0,20}(?:\.\d{0,20})?$ readOnly: true description: Lowest first. auth_providers: type: array items: $ref: '#/components/schemas/App_Auth_ProviderAppAuthProvider' description: Auth providers related to this user source. table_id: type: integer nullable: true description: The id of the Baserow table we want the data for. email_field_id: type: integer nullable: true description: The id of the field to use as email for the user account. name_field_id: type: integer nullable: true description: The id of the field that contains the user name. role_field_id: type: integer nullable: true description: The id of the field that contains the user role. required: - id - name - order - type - uid Heading1FontWeightEnum: enum: - thin - extra-light - light - regular - medium - semi-bold - bold - extra-bold - heavy - black - extra-black type: string description: '* `thin` - Thin * `extra-light` - Extra Light * `light` - Light * `regular` - Regular * `medium` - Medium * `semi-bold` - Semi Bold * `bold` - Bold * `extra-bold` - Extra Bold * `heavy` - Heavy * `black` - Black * `extra-black` - Extra Black' NavigationTypeEnum: enum: - page - custom type: string description: '* `page` - Page * `custom` - Custom' TableCellAlignmentEnum: enum: - left - center - right type: string description: '* `left` - Left * `center` - Center * `right` - Right' LocalBaserowPasswordAppAuthProviderAppAuthProvider: type: object description: Basic app_auth_provider serializer mostly for returned values. properties: type: type: string readOnly: true description: The type of the app_auth_provider. id: type: integer readOnly: true domain: type: string nullable: true description: The email domain registered with this provider. maxLength: 255 password_field_id: type: integer nullable: true description: The id of the field to use as password for the user account. required: - id - type CoreIteratorServiceService: type: object description: Basic service serializer mostly for returned values. properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The integration used to establish the connection with the service. readOnly: true type: type: string readOnly: true description: The type of the service. schema: type: object additionalProperties: {} readOnly: true description: The schema of the service. context_data: type: object additionalProperties: {} readOnly: true description: The context data of the service. context_data_schema: type: object additionalProperties: {} readOnly: true description: The schema context data of the service. sample_data: readOnly: true nullable: true description: Store the sample data used for generating a schema. source: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The path of the array. required: - context_data - context_data_schema - id - integration_id - sample_data - schema - type Integration_ServiceService: oneOf: - $ref: '#/components/schemas/LocalBaserowGetRowService' - $ref: '#/components/schemas/LocalBaserowListRowsService' - $ref: '#/components/schemas/LocalBaserowAggregateRowsService' - $ref: '#/components/schemas/LocalBaserowUpsertRowService' - $ref: '#/components/schemas/LocalBaserowDeleteRowService' - $ref: '#/components/schemas/LocalBaserowRowsCreatedService' - $ref: '#/components/schemas/LocalBaserowRowsUpdatedService' - $ref: '#/components/schemas/LocalBaserowRowsDeletedService' - $ref: '#/components/schemas/SlackWriteMessageServiceService' - $ref: '#/components/schemas/CoreHTTPRequestServiceService' - $ref: '#/components/schemas/CoreSMTPEmailServiceService' - $ref: '#/components/schemas/CoreRouterServiceService' - $ref: '#/components/schemas/CoreHTTPTriggerServiceService' - $ref: '#/components/schemas/CoreIteratorServiceService' - $ref: '#/components/schemas/CorePeriodicServiceService' - $ref: '#/components/schemas/AIAgentServiceService' - $ref: '#/components/schemas/LocalBaserowGroupedAggregateRowsService' discriminator: propertyName: type mapping: local_baserow_get_row: '#/components/schemas/LocalBaserowGetRowService' local_baserow_list_rows: '#/components/schemas/LocalBaserowListRowsService' local_baserow_aggregate_rows: '#/components/schemas/LocalBaserowAggregateRowsService' local_baserow_upsert_row: '#/components/schemas/LocalBaserowUpsertRowService' local_baserow_delete_row: '#/components/schemas/LocalBaserowDeleteRowService' local_baserow_rows_created: '#/components/schemas/LocalBaserowRowsCreatedService' local_baserow_rows_updated: '#/components/schemas/LocalBaserowRowsUpdatedService' local_baserow_rows_deleted: '#/components/schemas/LocalBaserowRowsDeletedService' slack_write_message: '#/components/schemas/SlackWriteMessageServiceService' http_request: '#/components/schemas/CoreHTTPRequestServiceService' smtp_email: '#/components/schemas/CoreSMTPEmailServiceService' router: '#/components/schemas/CoreRouterServiceService' http_trigger: '#/components/schemas/CoreHTTPTriggerServiceService' iterator: '#/components/schemas/CoreIteratorServiceService' periodic: '#/components/schemas/CorePeriodicServiceService' ai_agent: '#/components/schemas/AIAgentServiceService' local_baserow_grouped_aggregate_rows: '#/components/schemas/LocalBaserowGroupedAggregateRowsService' AIAgentServiceBasePolymorphicRequest: type: object properties: id: type: integer readOnly: true integration_id: type: integer nullable: true description: The ID of the AI integration to use for this service. ai_generative_ai_type: type: string nullable: true description: The generative AI provider type (e.g., 'openai', 'anthropic'). ai_generative_ai_model: type: string nullable: true description: The specific AI model to use (e.g., 'gpt-4', 'claude-3-opus'). ai_output_type: allOf: - $ref: '#/components/schemas/AiOutputType5efEnum' default: text description: 'The output type: ''text'' for raw text, ''choice'' for constrained selection. * `text` - Text * `choice` - Choice' ai_temperature: type: number format: double maximum: 2 minimum: 0 nullable: true description: Temperature for response randomness (0-2). Lower is more focused. ai_prompt: type: object additionalProperties: {} default: formula: '' version: '0.1' mode: simple description: The prompt to send to the AI model. Can be a formula. ai_choices: type: array items: type: string description: List of choice options for 'choice' output type. required: - id PathParam: type: object properties: name: type: string description: The name of the parameter. maxLength: 255 type: allOf: - $ref: '#/components/schemas/TypeC70Enum' description: 'The type of the parameter. * `text` - text * `numeric` - numeric' 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