Baserow
Operations
Health check endpoint to check if the the celery and/or export celery queue has exceeded the maximum healthy size. Responds with 200 if there there are less than 10 in all queues provided. Otherwi...
Sends a test email to the provided email address. Useful for testing Baserow's email configuration as errors are clearly returned.
Runs a full health check testing as many services and systems as possible. These health checks can be expensive operations such as writing files to storage etc.
List all distinct action types related to an audit log entry.
This is a enterprise feature.
Creates a job to export the filtered audit log to a CSV file.
This is a enterprise feature.
Lists all audit log entries for the given workspace id.
This is a enterprise feature.
List all users that have performed an action in the audit log.
This is a enterprise feature.
List all distinct workspace names related to an audit log entry.
This is a enterprise feature.
Delete an authentication provider.
Get an authentication provider.
Updates a new authentication provider. This can be used to enable authentication with a third party service like Google or Facebook.
List all the available authentication providers.
Creates a new authentication provider. This can be used to enable authentication with a third party service like Google or Facebook.
Returns the new and active users for the last 24 hours, 7 days and 30 days. The previous_ values are the values of the period before, so for example previous_new_users_last_24_hours are the new use...
Returns all users with detailed information on each user, if the requesting user is staff.
This endpoint allows staff to impersonate another user by requesting a JWT token and user object. The requesting user must have staff access in order to do this. It's not possible to impersonate a ...
Creates and returns a new user if the requesting user is staff. This works even if new signups are disabled.
Deletes the specified user, if the requesting user has admin permissions. You cannot delete yourself.
Updates specified user attributes and returns the updated user if the requesting user is staff. You cannot update yourself to no longer be an admin or active.
Returns all workspaces with detailed information on each workspace, if the requesting user is staff.
Deletes the specified workspace and the applications inside that workspace, if the requesting user is staff.
Lists all the integrations of the application related to the provided parameter if the user has access to the related application's workspace. If the workspace is related to a template, then this e...
Creates a new integration
List per user sources the first 5 users available.
Lists all the user_sources of the application related to the provided parameter if the user has access to the related application's workspace. If the workspace is related to a template, then this e...
Creates a new user_source
Lists all the roles of the application related to the provided parameter if the user has access to the related application's workspace. If the workspace is related to a template, then this endpoint...
Deletes an application if the authorized user is in the application's workspace. All the related children are also going to be deleted. For example in case of a database application all the underly...
Duplicate an application if the authorized user is in the application's workspace. All the related children are also going to be duplicated. For example in case of a database application all the un...
Returns the requested application if the authorized user is in the application's workspace. The properties that belong to the application can differ per type.
Updates the existing application related to the provided application_id param if the authorized user is in the application's workspace. It is not possible to change the type, but properties like th...
Lists all the applications that the user has access to. The properties that belong to the application can differ per type. An application always belongs to a single workspace. All the applications ...
Lists all the applications of the workspace related to the provided workspace_id parameter if the authorized user is in that workspace. If theworkspace is related to a template, then this endpoint ...
Changes the order of the provided application ids to the matching position that the id has in the list. If the authorized user does not belong to the workspace it will be ignored. The order of the ...
Creates a new application based on the provided type. The newly created application is going to be added to the workspace related to the provided workspace_id parameter. If the authorized user does...
List all distinct action types related to an audit log entry.
This is a enterprise feature.
Creates a job to export the filtered audit log to a CSV file.
This is a enterprise feature.
Lists all audit log entries for the given workspace id.
This is a enterprise feature.
List all users that have performed an action in the audit log.
This is a enterprise feature.
List all distinct workspace names related to an audit log entry.
This is a enterprise feature.
Lists the available login options for the configured authentication providers.
Gets all the domains of a builder
Apply a new order to the domains of a builder
Creates a new domain for an application builder
Apply a new order to the pages of a builder
Creates a new page for an application builder
Updates the theme properties for the provided id.
Moves the data_source in the page before another data_source or at the end of the page if no before data_source is given. The data_sources must belong to the same page.
Deletes the data_source related by the given id.
Dispatches the service of the related data_source and returns the result.
Updates an existing builder data_source.
Find the record names associated with a given list of record ids.
This endpoint can be used to check whether a domain exists for SSL certificate purposes. It's compatible with the Caddy on_demand TLS as described here: https://caddyserver.com/docs/json/apps/tls/a...
Deletes an existing domain of an application builder
Updates an existing domain of an application builder
This endpoint starts an asynchronous job to publish the builder. The job clones the current version of the given builder and publish it for the given domain.
Returns the public serialized version of the builder and its pages for the given builder id.
Returns the public serialized version of the builder for the given domain name and its pages .
Dispatches the service of the related data_source and returns the result.
Lists all the data_sources of the page related to the provided parameter if the builder is public.
Dispatches the service of the related page data_sources
Lists all the elements of the page related to the provided parameter. If the user is Anonymous, the page must belong to a published builder instance to being accessible.
Lists all the workflow actions with their public accessible data. Some configuration might be omitted for security reasons such as passwords or PII.
Deletes the element related by the given id.
Duplicates an element and all of the elements children and the associated workflow actions as well.
Moves the element in the page before another element or at the end of the page if no before element is given. The elements must belong to the same page.
Updates an existing builder element.
Lists all the data_sources 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 wil...
Creates a new builder data_source
Dispatches the service of the related page data_sources
Lists all the elements 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...
Creates a new builder element
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...
Apply a new order to the workflow actions of a page
Creates a new builder workflow action
Deletes an existing page of an application builder
Start a job to duplicate the page with the provided page_id parameter if the authorized user has access to the builder's workspace.
Updates an existing page of an application builder
Deletes the workflow action related by the given id.
Dispatches the service of the related workflow_action and returns the result.
Updates an existing builder workflow action.
Lists all the data sources of the dashboard if the user has access to the related dashboard's workspace.
Lists all the widgets of the dashboard related to the provided parameter if the user has access to the related workspace.
Creates a new dashboard widget
Dispatches the service of the related data source and returns the result.
Updates an existing dashboard data source.
Deletes the widget related to the given id.
Updates an existing dashboard widget.
Responds with the periodic data sync interval data, if the user has the right permissions.
This is an enterprise feature.
Updates the periodic data sync interval, if the user has the right permissions.
This is an enterprise feature.
Responds with the data sync, including the data sync type specific properties, if the user has the right permissions.
Updates the properties of the provided data sync, if the user has the right permissions. Note that if the synced_properties is not provided, the available properties change, then the unavailable on...
Lists all the available properties of the provided data sync.
Start a job to sync the data sync table with the provided data_sync_id parameter if the authorized user has access to the database's workspace.
Creates a new data sync table with the given data sync type. This will technically create a table, but it's synchronized with the provided data sync information. This means that some fields related...
Lists all the properties of the provided data sync type given the request data. This can be used to choose which properties should be included when creating the data sync.
Returns information such as export progress and state or the url of the exported file for the specified export job, only if the requesting user has access.
Creates and starts a new export job for a table given some exporter options. Returns an error if the requesting user does not have permissionsto view the table.
Deletes the existing field if the authorized user has access to the related database's workspace. Note that all the related data to that field is also deleted. Primary fields cannot be deleted beca...
Duplicates the table with the provided table_id parameter if the authorized user has access to the database's workspace.
Endpoint that's used by the AI field to start an sync task that will update the cell value of the provided row IDs based on the dynamically constructed prompt configured in the field settings.
This...
Returns the existing field if the authorized user has access to the related database's workspace. Depending on the type different properties could be returned.
Updates the existing field if the authorized user has access to the related database's workspace. The type can also be changed and depending on that type, different additional properties can option...
Returns a list of all the unique row values for an existing field, sorted in order of frequency.
Changes the primary field of a table to the one provided in the body payload.
This endpoint generates a Baserow formula for the table related to the provided id, based on the human readable input provided in the request body.
This is a premium feature.
Lists all the fields of the table related to the provided parameter if the user has access to the related database's workspace. If the workspace is related to a template, then this endpoint will be...
Creates a new field for the table related to the provided table_id parameter if the authorized user has access to the related database's workspace. Depending on the type, different properties can o...
Calculates and returns the type of the specified formula value. Does not change the state of the field in any way.
Returns the names of the given row of the given tables. The nameof a row is the primary field value for this row. The result can be usedfor example, when you want to display the name of a linked ro...
Deletes existing rows in the table if the user has access to the table's workspace.
WARNING: This endpoint doesn't yet work with row deleted webhooks.
Updates existing rows in the table if the user has access to the related table's workspace. The accepted body fields are depending on the fields that the table has. For a complete overview of field...
Creates new rows in the table if the user has access to the related table's workspace. The accepted body fields are depending on the fields that the table has. For a complete overview of fields use...
Lists all the rows of the table related to the provided parameter if the user has access to the related database's workspace. The response is paginated by a page/size style. It is also possible to ...
Creates a new row in the table if the user has access to the related table's workspace. The accepted body fields are depending on the fields that the table has. For a complete overview of fields us...
Fetches the adjacent row to a given row_id in the table with the given table_id. If the previous flag is set it will return the previous row, otherwise it will return the next row. You can specifya...
Deletes an existing row in the table if the user has access to the table's workspace.
Fetches an existing row from the table if the user has access to the related table's workspace. The properties of the returned row depend on which fields the table has. For a complete overview of f...
Fetches the row change history of a given row_id in the table with the given table_id. The row change history is paginated and can be limited with the limit and offset query parameters.
Moves the row related to given row_id parameter to another position. It is only possible to move the row before another existing row or to the end. If the before_id is provided then the row related...
Updates an existing row in the table if the user has access to the related table's workspace. The accepted body fields are depending on the fields that the table has. For a complete overview of fie...
Creates a job that creates a new table for the database related to the provided database_id parameter if the authorized user has access to the database's workspace. This endpoint is asynchronous an...
Lists all the tables that are in the database related to the database_id parameter if the user has access to the database's workspace. A table is exactly as the name suggests. It can hold multiple ...
Changes the order of the provided table ids to the matching position that the id has in the list. If the authorized user does not belong to the workspace it will be ignored. The order of the not pr...
Creates synchronously a new table for the database related to the provided database_id parameter if the authorized user has access to the database's workspace.
As an alternative you can use the cr...
Deletes the existing table if the authorized user has access to the related database's workspace.
Start a job to duplicate the table with the provided table_id parameter if the authorized user has access to the database's workspace.
Returns the requested table if the authorized user has access to the related database's workspace.
Import data in the specified table if the authorized user has access to the related database's workspace. This endpoint is asynchronous and return the created job to track the progress of the task.
Updates the existing table if the authorized user has access to the related database's workspace.
This endpoint check be used to check if the provided personal API token is valid. If returns a 200 response if so and a 403 is not. This can be used by integrations like Zapier or n8n to test if a ...
Lists all the database tokens that belong to the authorized user. A token can be used to create, read, update and delete rows in the tables of the token's workspace. It only works on the tables if ...
Creates a new database token for a given workspace and for the authorized user.
Deletes the existing database token if it is owned by the authorized user and ifthe user has access to the related workspace.
Returns the requested database token if it is owned by the authorized user andif the user has access to the related workspace.
Updates the existing database token if it is owned by the authorized user and ifthe user has access to the related workspace.
Returns information such as export progress and state or the url of the exported file for the specified export job, only if the requesting user has access.
This is a premium feature.
Creates and starts a new export job for a publicly shared view given some exporter options. Returns an error if the view doesn't support exporting.
This is a premium feature.
Sets view attributes only available for premium users.
Returns ICal feed for a specific Calendar view identified by ical_slug value. Calendar View resource contains full url in .ical_feed_url field.
Responds with serialized rows grouped by the view's date field options related to the slug if the calendar view is publicly shared. Additional query parameters can be provided to control the limit ...
Responds with serialized rows grouped by date regarding view's date fieldif the user is authenticated and has access to the related workspace.
This is a premium feature.
Rotates the unique slug of the calendar view's ical feed by replacing it with a new value. This would mean that the publicly shared URL of the view will change. Anyone with the old URL won't be abl...
Deletes the existing decoration if the authorized user has access to the related database's workspace.
Returns the existing view decoration if the current user has access to the related database's workspace.
Updates the existing decoration if the authorized user has access to the related database's workspace.
Deletes the existing filter group with the given view_filter_group_id.
Returns the existing view filter group with the given view_filter_group_id.
Updates the existing filter group with the given view_filter_group_id.
Deletes the existing filter if the authorized user has access to the related database's workspace.
Returns the existing view filter.
Updates the existing filter.
Returns the metadata related to the form view if the form is publicly shared or if the user has access to the related workspace. This data can be used to construct a form with the right fields.
Submits the form if the form is publicly shared or if the user has access to the related workspace. The provided data will be validated based on the fields that are in the form and the rules per fi...
Uploads a file anonymously to Baserow by uploading the file contents directly. A file multipart is expected containing the file contents.
Lists the requested rows of the view's table related to the provided slug if the gallery view is public.The response is paginated either by a limit/offset or page/size style. The style depends on t...
Lists the requested rows of the view's table related to the provided view_id if the authorized user has access to the database's workspace. The response is paginated by a limit/offset style.
Returns all field aggregations values previously defined for this grid view. If filters exist for this view, the aggregations are computed only on filtered rows.
Lists the requested rows of the view's table related to the provided slug if the grid view is public.The response is paginated either by a limit/offset or page/size style. The style depends on the ...
Computes the aggregation of all the values for a specified field from the selected grid view. You must select the aggregation type by setting the type GET parameter. If filters are configured for t...
Returns all field aggregations values previously defined for this grid view. If filters exist for this view, the aggregations are computed only on filtered rows.You need to have read permissions on...
Lists the requested rows of the view's table related to the provided view_id if the authorized user has access to the database's workspace. The response is paginated either by a limit/offset or pag...
Lists only the rows and fields that match the request. Only the rows with the ids that are in the row_ids list are going to be returned. Same goes for the fields, only the fields with the ids in th...
Deletes the existing group by if the authorized user has access to the related database's workspace.
Returns the existing view group by if the authorized user has access to the related database's workspace.
Updates the existing group by if the authorized user has access to the related database's workspace.
Responds with serialized rows grouped by the view's single select field options related to the slug if the kanban view is publicly shared. Additional query parameters can be provided to control the...
Responds with serialized rows grouped by the view's single select field options if the user is authenticated and has access to the related workspace. Additional query parameters can be provided to ...
If the view is publicly shared or if an authenticated user has access to the related workspace, then this endpoint can be used to do a value lookup of the link row fields that are included in the v...
Returns a valid never-expiring JWT token for this public shared view if the password provided matches with the one saved by the view's owner.
Returns the required public information to display a single shared view.
Deletes the existing sort if the authorized user has access to the related database's workspace.
Returns the existing view sort if the authorized user has access to the related database's workspace.
Updates the existing sort if the authorized user has access to the related database's workspace.
Lists all views of the table related to the provided table_id. If the workspace is related to a template, then this endpoint will be publicly accessible. A table can have multiple views. Each view ...
Changes the order of the provided view ids to the matching position that the id has in the list. The order of the not provided views will be set to 0.
Creates a new view for the table related to the provided table_id parameter. Depending on the type, different properties can optionally be set.
Lists the requested rows of the view's table related to the provided slug if the timeline view is public.The response is paginated either by a limit/offset or page/size style. The style depends on ...
Lists the requested rows of the view's table related to the provided view_id if the authorized user has access to the database's workspace. The response is paginated either by a limit/offset or pag...
Lists all decorations of the view related to the provided view_id if the user has access to the related database's workspace. A view can have multiple decorations. View decorators can be used to de...
Creates a new decoration for the view related to the provided view_id parameter if the authorized user has access to the related database's workspace.
Deletes the existing view. Note that all the related settings of the view are going to be deleted also. The data stays intact after deleting the view because this is related to the table and not th...
Duplicates an existing view if the user has access to it. When a view is duplicated everything is copied except:
The name is appended with the copy number. Ex: ViewName->ViewName(2) and View(2)->...
Responds with the fields options of the provided view if the authenticated user has access to the related workspace.
Updates the field options of a view. The field options differ per field type This could for example be used to update the field width of a grid view if the user changes it.
Creates a new filter group for the view related to the provided view_id parameter.
Lists all filters of the view related to the provided view_id. A view can have multiple filters. When all the rows are requested for the view only those that apply to the filters are returned.
Creates a new filter for the view related to the provided view_id parameter. When the rows of a view are requested, for example via the list_database_table_grid_view_rows endpoint, then only the ro...
Returns the existing view. Depending on the type different properties could be returned.
Lists all groupings of the view related to the provided view_id if the user has access to the related database's workspace. A view can have multiple groupings.
Creates a new group by for the view related to the provided view_id parameter if the authorized user has access to the related database's workspace.
Updates the existing view. The type cannot be changed. It depends on the existing type which properties can be changed.
Rotates the unique slug of the view by replacing it with a new value. This would mean that the publicly shared URL of the view will change. Anyone with the old URL won't be able to access the viewa...
Lists all sortings of the view related to the provided view_id if the user has access to the related database's workspace. A view can have multiple sortings. When all the rows are requested they wi...
Creates a new sort for the view related to the provided view_id parameter if the authorized user has access to the related database's workspace. When the rows of a view are requested, for example v...
Lists all webhooks of the table related to the provided table_id if the user has access to the related database workspace.
Creates a new webhook for the table related to the provided table_id parameter if the authorized user has access to the related database workspace.
This endpoint triggers a test call based on the provided data if the user has access to the workspace related to the table. The test call will be made immediately and a copy of the request, respons...
Deletes the existing webhook if the authorized user has access to the related database's workspace.
Returns the existing webhook if the authorized user has access to the related database workspace.
Updates the existing view if the authorized user has access to the related database workspace.
Downloads a file using the backend and the secure file serve feature. The signed data is extracted from the URL and used to verify if the user has access to the file. If the permissions check passe...
Deletes the integration related by the given id.
Moves the integration in the application before another integration or at the end of the application if no before integration is given. The integrations must belong to the same application.
Updates an existing integration.
List all existing jobs. Jobs are task executed asynchronously in the background. You can use the get_job endpoint to read the currentprogress of a the job.
Cancels a job. Note: you can cancel only a scheduled or a job that is already running. The user requesting must be the owner of the job to cancel.
Returns the information related to the provided job id. This endpoint can for example be polled to get the state and progress of the job in real time.
Creates a new job. This job runs asynchronously in the background and execute the task specific to the provided typeparameters. The get_job can be used to get the current state of the job.
Lists all the valid licenses that are registered to this instance. A premium license can be used to unlock the premium features for a fixed amount of users. An enterprise license can similarly be u...
This endpoint checks with the authority if the license needs to be updated. It also checks if the license is operating within its limits and might take action on that. It could also happen that the...
Removes the existing license related to the provided parameter. If the license is active, then all the users that are using the license will lose access to the features granted by that license.
Fills the remaining empty seats of the license with the first users that are found.
Responds with detailed information about the license related to the provided parameter.
This endpoint can be used to lookup users that can be added to a license. Users that are already in the license are not returned here. Optionally a search query parameter can be provided to filter...
Removes all the users that are on the license. This will empty all the seats.
Removes the user related to the provided parameter and to the license related to the parameter. This only happens if the user is on the license, otherwise nothing will happen.
Adds the user related to the provided parameter and to the license related to the parameter. This only happens if there are enough seats left on the license and if the user is not already on the li...
Registers a new license. After registering you can assign users to the license that will be able to use the license's features while the license is active. If an existing license with the same lice...
Clear all the notifications for the given workspace and user.
Lists the notifications for the given workspace and the current user. The response is paginated and the limit and offset parameters can be controlled using the query parameters.
Mark as read all the notifications for the given workspace and user.
Marks a notification as read.
You can assign a role to a multiple subjects into the given workspace for the given scopes with this endpoint. If you want to remove the role you can omit the role property.
You can list the role assignments within a workspace, optionally filtered downto a specific scope inside of that workspace. If the scope isn't specified,the workspace will be considered the scope.
You can assign a role to a subject into the given workspace for the given scope with this endpoint. If you want to remove the role you can omit the role property.
Delete a row comment.
This is a premium feature.
Update a row comment.
This is a premium feature.
Returns all row comments for the specified table and row.
This is a premium feature.
Updates the user's notification preferences for comments made on a specified table row.
This is a premium feature.
Creates a comment on the specified row.
This is a premium feature.
Responds with all the admin configured settings.
Responds with the self hosted instance id. Only a user with staff permissions can request it.
Updates the admin configured settings if the user has admin permissions.
Lists snapshots that were created for a given application.
Creates a new application snapshot. Snapshots represent a state of an application at a specific point in time and can be restored later, making it easy to create backups of entire applications.
Deletes a snapshot. Deleting a snapshot doesn't affect the application that the snapshot is made from and doesn't affect any applications that were created by restoring it. Snapshot deletion is per...
Restores a snapshot. When an application snapshot is restored, a new application will be created in the same workspace that the original application was placed in with the name of the snapshot and ...
Processes callback from OAuth2 provider and logs the user in if successful.
Redirects to the OAuth2 provider's authentication URL based on the provided auth provider's id.
Complete the SAML authentication flow by validating the SAML response. Sign in the user if already exists in Baserow or create a new one otherwise. Once authenticated, the user will be redirected t...
This is the endpoint that is called when the user wants to initiate a SSO SAML login from Baserow (the service provider). The user will be redirected to the SAML identity provider (IdP) where the u...
Return the correct redirect_url to initiate the SSO SAML login. It needs an email address if multiple SAML providers are configured otherwise the only configured SAML provider signup URL will be re...
Deletes a team if the authorized user is in the team's workspace. All the related children (e.g. subjects) are also going to be deleted.
Returns the information related to the provided team id.
Updates an existing team with a new name.
Lists all team subjects in a given team.
Creates a new team subject.
Deletes a subject if the authorized user is in the team's workspace.
Returns the information related to the provided subject id
Lists all teams in a given workspace.
Creates a new team.
Lists all the template categories and the related templates that are in that category. The template's workspace_id can be used for previewing purposes because that workspace contains the applicatio...
Start an async job to install the applications of the given template into the given workspace if the user has access to that workspace. The response contains those newly created applications.
(Deprecated) Installs the applications of the given template into the given workspace if the user has access to that workspace. The response contains those newly created applications.
Responds with the workspaces and applications available for the requesting user to inspect the trash contents of.
Restores the specified trashed item back into baserow.
Empties the specified workspace and/or application of trash, including the workspace and application themselves if they are trashed also.
Responds with trash contents for a workspace optionally filtered to a specific application.
Updates the account information of the authenticated user.
Changes the password of an authenticated user, but only if the old password matches.
Lists all the relevant user information that for example could be shown on a dashboard. It will contain all the pending workspace invitations for that user.
Uploads a file to Baserow by uploading the file contents directly. A file multipart is expected containing the file contents.
Uploads a file to Baserow by downloading it from the provided URL.
Creates a new user based on the provided values. If desired an authentication JWT can be generated right away. After creating an account the initial workspace containing a database is created.
Redoes the latest redoable action performed by the user making the request. a ClientSessionId header must be provided and only actions which were performed the same user with the same ClientSession...
Changes the password of a user if the reset token is valid. The send_password_reset_email endpoint sends an email to the user containing the token. That token can be used to change the password her...
Schedules the account deletion of the authenticated user. The user will be permanently deleted after the grace delay defined by the instance administrator.
Sends an email containing the password reset link to the email address of the user. This will only be done if a user is found with the given email address. The endpoint will not fail if the email a...
Sends an email to the user with an email verification link if the user's email is not verified yet.
Generate a new access_token that can be used to continue operating on Baserow with a user source user starting from a valid refresh token.
Complete the SAML authentication flow by validating the SAML response. Sign in the user if already exists in the user source or create a new one otherwise.Once authenticated, the user will be redir...
Blacklists the provided user source token. This can be used the sign the user off.
Deletes the user_source related by the given id.
Force authenticates an existing user based on their ID. If successful, an access token and a refresh token will be returned.
Moves the user_source in the application before another user_source or at the end of the application if no before user_source is given. The user_sources must belong to the same application.
Updates an existing user_source.
Authenticates an existing user against a user source based on their credentials. If successful, an access token and a refresh token will be returned.
Processes callback from OAuth2 provider and logs the user in if successful.
Redirects to the OAuth2 provider's authentication URL based on the provided user source uid and issuer.
This is the endpoint that is called when the user wants to initiate a SSO SAML login from Baserow (the service provider). The user will be redirected to the SAML identity provider (IdP) where the u...
Authenticates an existing user based on their email and their password. If successful, an access token and a refresh token will be returned.
Blacklists the provided token. This can be used the sign the user off.
Generate a new access_token that can be used to continue operating on Baserow starting from a valid refresh token.
Verifies if the refresh token is valid and can be used to generate a new access_token.
undoes the latest undoable action performed by the user making the request. a ClientSessionId header must be provided and only actions which were performed the same user with the same ClientSession...
Passing the correct verification token will confirm that the user's email address belongs to the user. This endpoint also optionally returns user information, access token and the refresh token for...
Creates an initial workspace. This is typically called after the user signs up and skips the onboarding in the frontend. It contains some example data.
Lists all the workspaces of the authorized user. A workspace can contain multiple applications like a database. Multiple users can have access to a workspace. For example each company could have th...
Responds with the serialized workspace invitation if an invitation with the provided token is found.
Accepts a workspace invitation with the given id if the email address of the user matches that of the invitation.
Deletes a workspace invitation if the authorized user has admin rights to the related workspace.
Returns the requested workspace invitation if the authorized user has admin right to the related workspace
Updates the existing workspace invitation related to the provided workspace_invitation_id param if the authorized user has admin rights to the related workspace.
Rejects a workspace invitation with the given id if the email address of the user matches that of the invitation.
Lists all the workspace invitations of the workspace related to the provided workspace_id parameter if the authorized user has admin rights to that workspace.
Creates a new workspace invitations for an email address if the authorized user has admin rights to the related workspace. An email containing a sign up link will be send to the user.
Changes the order of the provided workspace ids to the matching position that the id has in the list. If the authorized user does not belong to the workspace it will be ignored. The order will be c...
Creates a new workspace where only the authorized user has access to. No initial data like database applications are added, they have to be created via other endpoints.
Deletes a workspace user if the authorized user has admin rights to the related workspace.
Updates the existing workspace user related to the provided workspace_user_id param if the authorized user has admin rights to the related workspace.
Lists all the users that are in a workspace if the authorized user has admin permissions to the related workspace. To add a user to a workspace an invitation must be sent first.
Deletes an existing workspace if the authorized user belongs to the workspace. All the applications, databases, tables etc that were in the workspace are going to be deleted also.
Export workspace or set of applications application if the authorized user is in the application's workspace. All the related children are also going to be exported. For example in case of a databa...
Lists exports that were created for given workspace.
Import a set of applications included in a given resource if the authorized user is in the specified workspace. This endpoint requires a valid resource_id of the uploaded file.
Delete a resource. This endpoint mark as ready for deletion the specified resource. This operation is not undoable. The user must be the owner of the resource to perform this action.
Uploads an exported workspace or a set of applications if the authorized user is in the workspace. The uploaded file must be a valid ZIP file containing the applications' data for future import.
Makes the authenticated user leave the workspace related to the provided workspace_id if the user is in that workspace. If the user is the last admin in the workspace, they will not be able to leav...
Updates the existing workspace related to the provided workspace_id parameter if the authorized user belongs to the workspace. It is not yet possible to add additional users to a workspace.
Returns a the permission data necessary to determine the permissions of a specific user over a specific workspace.
See core.handler.CoreHandler.get_permissions() for more details.
Returns the generative AI models settings for the given workspace.
Updates the generative AI models settings for the given workspace.