project.md

lib_BaseRow

This is the Baserow No Code connector for Convertigo. Use this connector to exchange data with Baserow databases.

References

C8Oforms

C8Oforms

see readme

CouchDb_schema

CouchDb_schema

see documentation

lib_ExtendedComponents_ui_ngx

lib_ExtendedComponents_ui_ngx

see readme

Connectors

Baserow_API_spec

Baserow_API_spec

Transactions

_api_admin_dashboard__GET : Returns the new and active users for the last 24 hours, 7 days and 30 days

_api_admin_dashboard__GET

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 users that signed up from 48 to 24 hours ago. It can be used to calculate an increase or decrease in the amount of signups. A list of the new and active users for every day for the last 30 days is also included.

This is a premium feature.

_api_admin_groups__GET : Returns all groups with detailed information on each group, if the requesting user is staff

_api_admin_groups__GET

Returns all groups with detailed information on each group, if the requesting user is staff.

This is a premium feature.

Variables

name	comment
page	Defines which page should be returned.
search	If provided only groups that match the query will be returned.
size	Defines how many groups should be returned per page.
sorts	A comma separated string of attributes to sort by, each attribute must be prefixed with `+` for a descending sort or a `-` for an ascending sort. The accepted attribute names are: id, name, application_count, created_on. For example `sorts=-id,-name` will sort the groups first by descending id and then ascending name. A sortparameter with multiple instances of the same sort attribute will respond with the ERROR_ADMIN_LISTING_INVALID_SORT_ATTRIBUTE error.

_api_admin_groups__group_id___DELETE : Deletes the specified group and the applications inside that group, if the requesting user is staff

_api_admin_groups__group_id___DELETE

Deletes the specified group and the applications inside that group, if the requesting user is staff.

This is a premium feature.

Variables

name	comment
group_id	The id of the group to delete

_api_admin_users__GET : Returns all users with detailed information on each user, if the requesting user is staff

_api_admin_users__GET

Returns all users with detailed information on each user, if the requesting user is staff.

This is a premium feature.

Variables

name	comment
page	Defines which page should be returned.
search	If provided only users that match the query will be returned.
size	Defines how many users should be returned per page.
sorts	A comma separated string of attributes to sort by, each attribute must be prefixed with `+` for a descending sort or a `-` for an ascending sort. The accepted attribute names are: id, is_active, name, username, date_joined, last_login. For example `sorts=-id,-is_active` will sort the users first by descending id and then ascending is_active. A sortparameter with multiple instances of the same sort attribute will respond with the ERROR_ADMIN_LISTING_INVALID_SORT_ATTRIBUTE error.

_api_admin_users__user_id___DELETE : Deletes the specified user, if the requesting user has admin permissions

_api_admin_users__user_id___DELETE

Deletes the specified user, if the requesting user has admin permissions. You cannot delete yourself.

This is a premium feature.

Variables

name	comment
user_id	The id of the user to delete

_api_admin_users__user_id___PATCH : Updates specified user attributes and returns the updated user if the requesting user is staff

_api_admin_users__user_id___PATCH

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.

This is a premium feature.

Variables

name	comment
__body
user_id	The id of the user to edit

_api_admin_users_impersonate__POST : This endpoint allows staff to impersonate another user by requesting a JWT token and user object

_api_admin_users_impersonate__POST

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 superuser or staff.

This is a premium feature.

Variables

name	comment
__body

_api_applications__application_id___DELETE : Deletes an application if the authorized user is in the application's group

_api_applications__application_id___DELETE

Deletes an application if the authorized user is in the application's group. All the related children are also going to be deleted. For example in case of a database application all the underlying tables, fields, views and rows are going to be deleted.

Variables

name	comment
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
application_id	Deletes the application related to the provided value.

_api_applications__application_id___GET : Returns the requested application if the authorized user is in the application's group

_api_applications__application_id___GET

Returns the requested application if the authorized user is in the application's group. The properties that belong to the application can differ per type.

Variables

name	comment
application_id	Returns the application related to the provided value.

_api_applications__application_id___PATCH : Updates the existing application related to the provided `application_id` param if the authorized user is in the application's group

_api_applications__application_id___PATCH

Updates the existing application related to the provided application_id param if the authorized user is in the application's group. It is not possible to change the type, but properties like the name can be changed.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
application_id	Updates the application related to the provided value.

_api_applications__application_id__duplicate_async__POST : Duplicate an application if the authorized user is in the application's group

_api_applications__application_id__duplicate_async__POST

Duplicate an application if the authorized user is in the application's group. All the related children are also going to be duplicated. For example in case of a database application all the underlying tables, fields, views and rows are going to be duplicated.

Variables

name	comment
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
application_id	The id of the application to duplicate.

_api_applications__GET : Lists all the applications that the authorized user has access to

_api_applications__GET

Lists all the applications that the authorized user has access to. The properties that belong to the application can differ per type. An application always belongs to a single group. All the applications of the groups that the user has access to are going to be listed here.

_api_applications_group__group_id___GET : Lists all the applications of the group related to the provided `group_id` parameter if the authorized user is in that group

_api_applications_group__group_id___GET

Lists all the applications of the group related to the provided group_id parameter if the authorized user is in that group. If thegroup is related to a template, then this endpoint will be publicly accessible. The properties that belong to the application can differ per type. An application always belongs to a single group.

Variables

name	comment
group_id	Returns only applications that are in the group related to the provided value.

_api_applications_group__group_id___POST : Creates a new application based on the provided type

_api_applications_group__group_id___POST

Creates a new application based on the provided type. The newly created application is going to be added to the group related to the provided group_id parameter. If the authorized user does not belong to the group an error will be returned.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
group_id	Creates an application for the group related to the provided value.

_api_applications_group__group_id__order__POST : Changes the order of the provided application ids to the matching position that the id has in the list

_api_applications_group__group_id__order__POST

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 group it will be ignored. The order of the not provided tables will be set to 0.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
group_id	Updates the order of the applications in the group related to the provided value.

_api_Auth

_api_Auth

Variables

name	comment
__body

_api_database_export__job_id___GET : Returns information such as export progress and status or the url of the exported file for the specified export job, only if the requesting user has access

_api_database_export__job_id___GET

Returns information such as export progress and status or the url of the exported file for the specified export job, only if the requesting user has access.

Variables

name	comment
job_id	The job id to lookup information about.

_api_database_export_table__table_id___POST : Creates and starts a new export job for a table given some exporter options

_api_database_export_table__table_id___POST

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.

Variables

name	comment
__body
table_id	The table id to create and start an export job for

_api_database_fields__field_id___DELETE : Deletes the existing field if the authorized user has access to the related database's group

_api_database_fields__field_id___DELETE

Deletes the existing field if the authorized user has access to the related database's group. Note that all the related data to that field is also deleted. Primary fields cannot be deleted because their value represents the row. If deleting the field causes other fields to change then the specificinstances of those fields will be included in the related fields response key.

Variables

name	comment
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
field_id	Deletes the field related to the provided value.

_api_database_fields__field_id___GET : Returns the existing field if the authorized user has access to the related database's group

_api_database_fields__field_id___GET

Returns the existing field if the authorized user has access to the related database's group. Depending on the type different properties could be returned.

Variables

name	comment
field_id	Returns the field related to the provided value.

_api_database_fields__field_id___PATCH : Updates the existing field if the authorized user has access to the related database's group

_api_database_fields__field_id___PATCH

Updates the existing field if the authorized user has access to the related database's group. The type can also be changed and depending on that type, different additional properties can optionally be set. If you change the field type it could happen that the data conversion fails, in that case the ERROR_CANNOT_CHANGE_FIELD_TYPE is returned, but this rarely happens. If a data value cannot be converted it is set to null so data might go lost.If updated the field causes other fields to change then the specificinstances of those fields will be included in the related fields response key.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
field_id	Updates the field related to the provided value.

_api_database_fields__field_id__duplicate_async__POST : Duplicates the table with the provided `table_id` parameter if the authorized user has access to the database's group

_api_database_fields__field_id__duplicate_async__POST

Duplicates the table with the provided table_id parameter if the authorized user has access to the database's group.

Variables

name	comment
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
field_id	The field to duplicate.

_api_database_fields__field_id__unique_row_values__GET : Returns a list of all the unique row values for an existing field, sorted in order of frequency

_api_database_fields__field_id__unique_row_values__GET

Returns a list of all the unique row values for an existing field, sorted in order of frequency.

Variables

name	comment
field_id	Returns the values related to the provided field.
limit	Defines how many values should be returned.
split_comma_separated	Indicates whether the original column values must be splitted by comma.

_api_database_fields_table__table_id___GET : Lists all the fields of the table related to the provided parameter if the user has access to the related database's group

_api_database_fields_table__table_id___GET

Lists all the fields of the table related to the provided parameter if the user has access to the related database's group. If the group is related to a template, then this endpoint will be publicly accessible. A table consists of fields and each field can have a different type. Each type can have different properties. A field is comparable with a regular table's column.

Variables

name	comment
table_id	Returns only the fields of the table related to the provided value.

_api_database_fields_table__table_id___POST : 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 group

_api_database_fields_table__table_id___POST

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 group. Depending on the type, different properties can optionally be set.If creating the field causes other fields to change then the specificinstances of those fields will be included in the related fields response key.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
table_id	Creates a new field for the provided table related to the value.

_api_database_formula__table_id__type__POST : Calculates and returns the type of the specified formula value

_api_database_formula__table_id__type__POST

Calculates and returns the type of the specified formula value. Does not change the state of the field in any way.

Variables

name	comment
__body
table_id	The table id of the formula field to type.

_api_database_rows_names__GET : Returns the names of the given row of the given tables

_api_database_rows_names__GET

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 row from another table.

Variables

name	comment
table___id_	A list of comma separated row ids to query from the table with id {id}. For example, if you want the name of row `42` and `43` from table `28` this parameter will be `table__28=42,43`. You can specify multiple rows for different tables but every tables must be in the same database. You need at least read permission on all specified tables.

_api_database_rows_table__table_id___GET : Lists all the rows of the table related to the provided parameter if the user has access to the related database's group

_api_database_rows_table__table_id___GET

Lists all the rows of the table related to the provided parameter if the user has access to the related database's group. The response is paginated by a page/size style. It is also possible to provide an optional search query, only rows where the data matches the search query are going to be returned then. The properties of the returned rows depends on which fields the table has. For a complete overview of fields use the list_database_table_fields endpoint to list them all. In the example all field types are listed, but normally the number in field_{id} key is going to be the id of the field. Or if the GET parameter user_field_names is provided then the keys will be the name of the field. The value is what the user has provided and the format of it depends on the fields type.

Variables

name	comment
exclude	All the fields are included in the response by default. You can select a subset of fields by providing the exclude query parameter. If you for example provide the following GET parameter `exclude=field_1,field_2` then the fields with id `1` and id `2` are going to be excluded from the selection and response. If the `user_field_names` parameter is provided then instead exclude should be a comma separated list of the actual field names. For field names with commas you should surround the name with quotes like so: `exclude=My Field,"Field With , "`. A backslash can be used to escape field names which contain double quotes like so: `exclude=My Field,Field with \"`.
filter_type	`AND`: Indicates that the rows must match all the provided filters. `OR`: Indicates that the rows only have to match one of the filters. This works only if two or more filters are provided.
filterExpression
include_fields	All the fields are included in the response by default. You can select a subset of fields by providing the include query parameter. If you for example provide the following GET parameter `include=field_1,field_2` then only the fields withid `1` and id `2` are going to be selected and included in the response. If the `user_field_names` parameter is provided then instead include should be a comma separated list of the actual field names. For field names with commas you should surround the name with quotes like so: `include=My Field,"Field With , "`. A backslash can be used to escape field names which contain double quotes like so: `include=My Field,Field with \"`.
order_by	Optionally the rows can be ordered by provided field ids separated by comma. By default a field is ordered in ascending (A-Z) order, but by prepending the field with a '-' it can be ordered descending (Z-A). If the `user_field_names` parameter is provided then instead order_by should be a comma separated list of the actual field names. For field names with commas you should surround the name with quotes like so: `order_by=My Field,"Field With , "`. A backslash can be used to escape field names which contain double quotes like so: `order_by=My Field,Field with \"`.
page	Defines which page of rows should be returned.
search	If provided only rows with data that matches the search query are going to be returned.
size	Defines how many rows should be returned per page.
table_id	Returns the rows of the table related to the provided value.
user_field_names	A flag query parameter which if provided the returned json will use the user specified field names instead of internal Baserow field names (field_123 etc).
view_id	Includes all the filters and sorts of the provided view.

_api_database_rows_table__table_id___POST : Creates a new row in the table if the user has access to the related table's group

_api_database_rows_table__table_id___POST

Creates a new row in the table if the user has access to the related table's group. The accepted body fields are depending on the fields that the table has. For a complete overview of fields use the list_database_table_fields to list them all. None of the fields are required, if they are not provided the value is going to be null or false or some default value is that is set. If you want to add a value for the field with for example id 10, the key must be named field_10. Or instead if the user_field_names GET param is provided the key must be the name of the field. Of course multiple fields can be provided in one request. In the examples below you will find all the different field types, the numbers/ids in the example are just there for example purposes, the field_ID must be replaced with the actual id of the field or the name of the field if user_field_names is provided.

Variables

name	comment
__body
__header_Authorization
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
before	If provided then the newly created row will be positioned before the row with the provided id.
table_id	Creates a row in the table related to the provided value.
user_field_names	A flag query parameter which if provided this endpoint will expect and return the user specified field names instead of internal Baserow field names (field_123 etc).

_api_database_rows_table__table_id___row_id___DELETE : Deletes an existing row in the table if the user has access to the table's group

_api_database_rows_table__table_id___row_id___DELETE

Deletes an existing row in the table if the user has access to the table's group.

Variables

name	comment
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
row_id	Deletes the row related to the value.
table_id	Deletes the row in the table related to the value.

_api_database_rows_table__table_id___row_id___GET : Fetches an existing row from the table if the user has access to the related table's group

_api_database_rows_table__table_id___row_id___GET

Fetches an existing row from the table if the user has access to the related table's group. The properties of the returned row depend on which fields the table has. For a complete overview of fields use the list_database_table_fields endpoint to list them all. In the example all field types are listed, but normally the number in field_{id} key is going to be the id of the field of the field. Or if the GET parameter user_field_names is provided then the keys will be the name of the field. The value is what the user has provided and the format of it depends on the fields type.

Variables

name	comment
row_id	Returns the row related the provided value.
table_id	Returns the row of the table related to the provided value.
user_field_names	A flag query parameter which if provided the returned json will use the user specified field names instead of internal Baserow field names (field_123 etc).

_api_database_rows_table__table_id___row_id___PATCH : Updates an existing row in the table if the user has access to the related table's group

_api_database_rows_table__table_id___row_id___PATCH

Updates an existing row in the table if the user has access to the related table's group. The accepted body fields are depending on the fields that the table has. For a complete overview of fields use the list_database_table_fields endpoint to list them all. None of the fields are required, if they are not provided the value is not going to be updated. When you want to update a value for the field with id 10, the key must be named field_10. Or if the GET parameter user_field_names is provided the key of the field to update must be the name of the field. Multiple different fields to update can be provided in one request. In the examples below you will find all the different field types, the numbers/ids in the example are just there for example purposes, the field_ID must be replaced with the actual id of the field or the name of the field if user_field_names is provided.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
row_id	Updates the row related to the value.
table_id	Updates the row in the table related to the value.
user_field_names	A flag query parameter which if provided this endpoint will expect and return the user specified field names instead of internal Baserow field names (field_123 etc).

_api_database_rows_table__table_id___row_id__adjacent__GET : Fetches the adjacent row to a given row_id in the table with the given table_id

_api_database_rows_table__table_id___row_id__adjacent__GET

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 view_id and it will apply the filters and sorts of the provided view.

Variables

name	comment
previous	A flag query parameter which if provided returns theprevious row to the specified row_id. If it's not setit will return the next row.
row_id	Returns the row adjacent the provided value.
search	If provided, the adjacent row will be one that matchesthe search query.
table_id	Returns the row of the table related to the provided value.
user_field_names	A flag query parameter which if provided the returned json will use the user specified field names instead of internal Baserow field names (field_123 etc).
view_id	Applies the filters and sorts of the provided view.

_api_database_rows_table__table_id___row_id__move__PATCH : Moves the row related to given `row_id` parameter to another position

_api_database_rows_table__table_id___row_id__move__PATCH

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 to the row_id parameter is moved before that row. If the before_id parameter is not provided, then the row will be moved to the end.

Variables

name	comment
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
before_id	Moves the row related to the given `row_id` before the row related to the provided value. If not provided, then the row will be moved to the end.
row_id	Moves the row related to the value.
table_id	Moves the row in the table related to the value.
user_field_names	A flag query parameter which if provided the returned json will use the user specified field names instead of internal Baserow field names (field_123 etc).

_api_database_rows_table__table_id__batch__PATCH : Updates existing rows in the table if the user has access to the related table's group

_api_database_rows_table__table_id__batch__PATCH

Updates existing rows in the table if the user has access to the related table's group. The accepted body fields are depending on the fields that the table has. For a complete overview of fields use the list_database_table_fields endpoint to list them all. None of the fields are required, if they are not provided the value is not going to be updated. When you want to update a value for the field with id 10, the key must be named field_10. Or if the GET parameter user_field_names is provided the key of the field to update must be the name of the field. Multiple different fields to update can be provided for each row. In the examples below you will find all the different field types, the numbers/ids in the example are just there for example purposes, the field_ID must be replaced with the actual id of the field or the name of the field if user_field_names is provided.

WARNING: This endpoint doesn't yet work with row updated webhooks.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
table_id	Updates the rows in the table.
user_field_names	A flag query parameter which if provided this endpoint will expect and return the user specified field names instead of internal Baserow field names (field_123 etc).

_api_database_rows_table__table_id__batch__POST : Creates new rows in the table if the user has access to the related table's group

_api_database_rows_table__table_id__batch__POST

Creates new rows in the table if the user has access to the related table's group. The accepted body fields are depending on the fields that the table has. For a complete overview of fields use the list_database_table_fields to list them all. None of the fields are required, if they are not provided the value is going to be null or false or some default value is that is set. If you want to add a value for the field with for example id 10, the key must be named field_10. Or instead if the user_field_names GET param is provided the key must be the name of the field. Of course multiple fields can be provided in one request. In the examples below you will find all the different field types, the numbers/ids in the example are just there for example purposes, the field_ID must be replaced with the actual id of the field or the name of the field if user_field_names is provided.

WARNING: This endpoint doesn't yet work with row created webhooks.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
before	If provided then the newly created rows will be positioned before the row with the provided id.
table_id	Creates the rows in the table.
user_field_names	A flag query parameter which if provided this endpoint will expect and return the user specified field names instead of internal Baserow field names (field_123 etc).

_api_database_rows_table__table_id__batch_delete__POST : Deletes existing rows in the table if the user has access to the table's group

_api_database_rows_table__table_id__batch_delete__POST

Deletes existing rows in the table if the user has access to the table's group.

WARNING: This endpoint doesn't yet work with row deleted webhooks.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
table_id	Deletes the rows in the table related to the value.

_api_database_tables__table_id___DELETE : Deletes the existing table if the authorized user has access to the related database's group

_api_database_tables__table_id___DELETE

Deletes the existing table if the authorized user has access to the related database's group.

Variables

name	comment
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
table_id	Deletes the table related to the provided value.

_api_database_tables__table_id___GET : Returns the requested table if the authorized user has access to the related database's group

_api_database_tables__table_id___GET

Returns the requested table if the authorized user has access to the related database's group.

Variables

name	comment
table_id	Returns the table related to the provided value.

_api_database_tables__table_id___PATCH : Updates the existing table if the authorized user has access to the related database's group

_api_database_tables__table_id___PATCH

Updates the existing table if the authorized user has access to the related database's group.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
table_id	Updates the table related to the provided value.

_api_database_tables__table_id__duplicate_async__POST : Duplicates the table with the provided `table_id` parameter if the authorized user has access to the database's group

_api_database_tables__table_id__duplicate_async__POST

Duplicates the table with the provided table_id parameter if the authorized user has access to the database's group.

Variables

name	comment
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
table_id	The table to duplicate.

_api_database_tables__table_id__import_async__POST : Import data in the specified table if the authorized user has access to the related database's group

_api_database_tables__table_id__import_async__POST

Import data in the specified table if the authorized user has access to the related database's group. This endpoint is asynchronous and return the created job to track the progress of the task.

Variables

name	comment
__body
__header_Authorization
table_id	Import data into the table related to the provided value.

_api_database_tables_database__database_id___GET : Lists all the tables that are in the database related to the `database_id` parameter if the user has access to the database's group

_api_database_tables_database__database_id___GET

Lists all the tables that are in the database related to the database_id parameter if the user has access to the database's group. A table is exactly as the name suggests. It can hold multiple fields, each having their own type and multiple rows. They can be added via the create_database_table_field and create_database_table_row endpoints.

Variables

name	comment
database_id	Returns only tables that are related to the provided value.

_api_database_tables_database__database_id___POST : 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 group

_api_database_tables_database__database_id___POST

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 group.

As an alternative you can use the create_async_database_table for better performances and importing bigger files.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
database_id	Creates a table for the database related to the provided value.

_api_database_tables_database__database_id__async__POST : 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 group

_api_database_tables_database__database_id__async__POST

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 group. This endpoint is asynchronous and return the created job to track the progress of the task.

Variables

name	comment
__body
__header_ClientSessionId	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.
database_id	Creates a table for the database related to the provided value.

_api_database_tables_database__database_id__order__POST : Changes the order of the provided table ids to the matching position that the id has in the list

_api_database_tables_database__database_id__order__POST

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 group it will be ignored. The order of the not provided tables will be set to 0.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
database_id	Updates the order of the tables in the database related to the provided value.

_api_database_tokens__GET : Lists all the API tokens that belong to the authorized user

_api_database_tokens__GET

Lists all the API tokens that belong to the authorized user. An API token can be used to create, read, update and delete rows in the tables of the token's group. It only works on the tables if the token has the correct permissions. The Database table rows endpoints can be used for these operations.

_api_database_tokens__POST : Creates a new API token for a given group and for the authorized user

_api_database_tokens__POST

Creates a new API token for a given group and for the authorized user.

Variables

name	comment
__body

_api_database_tokens__token_id___DELETE : Deletes the existing token if it is owned by the authorized user and ifthe user has access to the related group

_api_database_tokens__token_id___DELETE

Deletes the existing token if it is owned by the authorized user and ifthe user has access to the related group.

Variables

name	comment
token_id	Deletes the token related to the provided value.

_api_database_tokens__token_id___GET : Returns the requested token if it is owned by the authorized user andif the user has access to the related group

_api_database_tokens__token_id___GET

Returns the requested token if it is owned by the authorized user andif the user has access to the related group.

Variables

name	comment
token_id	Returns the token related to the provided value.

_api_database_tokens__token_id___PATCH : Updates the existing token if it is owned by the authorized user and ifthe user has access to the related group

_api_database_tokens__token_id___PATCH

Updates the existing token if it is owned by the authorized user and ifthe user has access to the related group.

Variables

name	comment
__body
token_id	Updates the token related to the provided value.

_api_database_tokens_check__GET : This endpoint check be used to check if the provided personal API token is valid

_api_database_tokens_check__GET

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 token is valid.

_api_database_view__view_id__premium_PATCH : Sets view attributes only available for premium users

_api_database_view__view_id__premium_PATCH

Sets view attributes only available for premium users.

Variables

name	comment
__body
view_id	Sets show_logo of this view.

_api_database_views__slug__link_row_field_lookup__field_id___GET : If the view is publicly shared or if an authenticated user has access to the related group, then this endpoint can be used to do a value lookup of the link row fields that are included in the view

_api_database_views__slug__link_row_field_lookup__field_id___GET

If the view is publicly shared or if an authenticated user has access to the related group, then this endpoint can be used to do a value lookup of the link row fields that are included in the view. Normally it is not possible for a not authenticated visitor to fetch the rows of a table. This endpoint makes it possible to fetch the id and primary field value of the related table of a link row included in the view.

Variables

name	comment
field_id	The field id of the link row field.
slug	The slug related to the view.

_api_database_views__slug__public_auth__POST : 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

_api_database_views__slug__public_auth__POST

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.

Variables

name	comment
__body
slug	The slug of the grid view to get public information about.

_api_database_views__slug__public_info__GET : Returns the required public information to display a single shared view

_api_database_views__slug__public_info__GET

Returns the required public information to display a single shared view.

Variables

name	comment
slug	The slug of the view to get public information about.

_api_database_views__view_id___DELETE : Deletes the existing view if the authorized user has access to the related database's group

_api_database_views__view_id___DELETE

Deletes the existing view if the authorized user has access to the related database's group. 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 the view.

Variables

name	comment
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
view_id	Deletes the view related to the provided value.

_api_database_views__view_id___GET : Returns the existing view if the authorized user has access to the related database's group

_api_database_views__view_id___GET

Returns the existing view if the authorized user has access to the related database's group. Depending on the type different propertiescould be returned.

Variables

name	comment
include	A comma separated list of extra attributes to include on the returned view. The supported attributes are `filters`, `sortings` and `decorations`. For example `include=filters,sortings` will add the attributes `filters` and `sortings` to every returned view, containing a list of the views filters and sortings respectively.
view_id	Returns the view related to the provided value.

_api_database_views__view_id___PATCH : Updates the existing view if the authorized user has access to the related database's group

_api_database_views__view_id___PATCH

Updates the existing view if the authorized user has access to the related database's group. The type cannot be changed. It depends on the existing type which properties can be changed.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
include	A comma separated list of extra attributes to include on the returned view. The supported attributes are `filters`, `sortings` and `decorations`. For example `include=filters,sortings` will add the attributes `filters` and `sortings` to every returned view, containing a list of the views filters and sortings respectively.
view_id	Updates the view related to the provided value.

_api_database_views__view_id__decorations__GET : Lists all decorations of the view related to the provided `view_id` if the user has access to the related database's group

_api_database_views__view_id__decorations__GET

Lists all decorations of the view related to the provided view_id if the user has access to the related database's group. A view can have multiple decorations. View decorators can be used to decorate rows. This can, for example, be used to change the border or background color of a row if it matches certain conditions.

Variables

name	comment
view_id	Returns only decoration of the view given to the provided value.

_api_database_views__view_id__decorations__POST : 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 group

_api_database_views__view_id__decorations__POST

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 group.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
view_id	Creates a decoration for the view related to the given value.

_api_database_views__view_id__duplicate__POST : Duplicates an existing view if the user has access to it

_api_database_views__view_id__duplicate__POST

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: View Name -> View Name (2) and View (2) -> View (3)
• If the original view is publicly shared, the new view will not be shared anymore

Variables

name	comment
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
view_id	Duplicates the view related to the provided value.

_api_database_views__view_id__field_options__GET : Responds with the fields options of the provided view if the authenticated user has access to the related group

_api_database_views__view_id__field_options__GET

Responds with the fields options of the provided view if the authenticated user has access to the related group.

Variables

name	comment
view_id	Responds with field options related to the provided value.

_api_database_views__view_id__field_options__PATCH : Updates the field options of a view

_api_database_views__view_id__field_options__PATCH

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.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
view_id	Updates the field options related to the provided value.

_api_database_views__view_id__filters__GET : Lists all filters of the view related to the provided `view_id` if the user has access to the related database's group

_api_database_views__view_id__filters__GET

Lists all filters of the view related to the provided view_id if the user has access to the related database's group. A view can have multiple filters. When all the rows are requested for the view only those that apply to the filters are returned.

Variables

name	comment
view_id	Returns only filters of the view related to the provided value.

_api_database_views__view_id__filters__POST : Creates a new filter for the view related to the provided `view_id` parameter if the authorized user has access to the related database's group

_api_database_views__view_id__filters__POST

Creates a new filter for the view related to the provided view_id parameter if the authorized user has access to the related database's group. When the rows of a view are requested, for example via the list_database_table_grid_view_rows endpoint, then only the rows that apply to all the filters are going to be returned. A filter compares the value of a field to the value of a filter. It depends on the type how values are going to be compared.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
view_id	Creates a filter for the view related to the provided value.

_api_database_views__view_id__rotate_slug__POST : Rotates the unique slug of the view by replacing it with a new value

_api_database_views__view_id__rotate_slug__POST

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 viewanymore. Only view types which are sharable can have their slugs rotated.

Variables

name	comment
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
view_id	Rotates the slug of the view related to the provided value.

_api_database_views__view_id__sortings__GET : Lists all sortings of the view related to the provided `view_id` if the user has access to the related database's group

_api_database_views__view_id__sortings__GET

Lists all sortings of the view related to the provided view_id if the user has access to the related database's group. A view can have multiple sortings. When all the rows are requested they will be in the desired order.

Variables

name	comment
view_id	Returns only sortings of the view related to the provided value.

_api_database_views__view_id__sortings__POST : 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 group

_api_database_views__view_id__sortings__POST

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 group. When the rows of a view are requested, for example via the list_database_table_grid_view_rows endpoint, they will be returned in the respected order defined by all the sortings.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
view_id	Creates a sort for the view related to the provided value.

_api_database_views_decoration__view_decoration_id___DELETE : Deletes the existing decoration if the authorized user has access to the related database's group

_api_database_views_decoration__view_decoration_id___DELETE

Deletes the existing decoration if the authorized user has access to the related database's group.

Variables

name	comment
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
view_decoration_id	Deletes the decoration related to the provided value.

_api_database_views_decoration__view_decoration_id___GET : Returns the existing view decoration if the current user has access to the related database's group

_api_database_views_decoration__view_decoration_id___GET

Returns the existing view decoration if the current user has access to the related database's group.

Variables

name	comment
view_decoration_id	Returns the view decoration related to the provided id.

_api_database_views_decoration__view_decoration_id___PATCH : Updates the existing decoration if the authorized user has access to the related database's group

_api_database_views_decoration__view_decoration_id___PATCH

Updates the existing decoration if the authorized user has access to the related database's group.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
view_decoration_id	Updates the view decoration related to the provided value.

_api_database_views_filter__view_filter_id___DELETE : Deletes the existing filter if the authorized user has access to the related database's group

_api_database_views_filter__view_filter_id___DELETE

Deletes the existing filter if the authorized user has access to the related database's group.

Variables

name	comment
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
view_filter_id	Deletes the filter related to the provided value.

_api_database_views_filter__view_filter_id___GET : Returns the existing view filter if the authorized user has access to the related database's group

_api_database_views_filter__view_filter_id___GET

Returns the existing view filter if the authorized user has access to the related database's group.

Variables

name	comment
view_filter_id	Returns the view filter related to the provided value.

_api_database_views_filter__view_filter_id___PATCH : Updates the existing filter if the authorized user has access to the related database's group

_api_database_views_filter__view_filter_id___PATCH

Updates the existing filter if the authorized user has access to the related database's group.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
view_filter_id	Updates the view filter related to the provided value.

_api_database_views_form__slug__submit__GET : Returns the meta data related to the form view if the form is publicly shared or if the user has access to the related group

_api_database_views_form__slug__submit__GET

Returns the meta data related to the form view if the form is publicly shared or if the user has access to the related group. This data can be used to construct a form with the right fields.

Variables

name	comment
slug	The slug related to the form form.

_api_database_views_form__slug__submit__POST : Submits the form if the form is publicly shared or if the user has access to the related group

_api_database_views_form__slug__submit__POST

Submits the form if the form is publicly shared or if the user has access to the related group. The provided data will be validated based on the fields that are in the form and the rules per field. If valid, a new row will be created in the table.

Variables

name	comment
__body
slug	The slug related to the form.

_api_database_views_form__slug__upload_file__POST : Uploads a file anonymously to Baserow by uploading the file contents directly

_api_database_views_form__slug__upload_file__POST

Uploads a file anonymously to Baserow by uploading the file contents directly. A file multipart is expected containing the file contents.

Variables

name	comment
slug	Submits files only if the view with the provided slughas a public file field.

_api_database_views_gallery__slug__public_rows__GET : Lists the requested rows of the view's table related to the provided `slug` if the gallery view is public

_api_database_views_gallery__slug__public_rows__GET

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 the provided GET parameters. The properties of the returned rows depends on which fields the table has. For a complete overview of fields use the list_database_table_fields endpoint to list them all. In the example all field types are listed, but normally the number in field_{id} key is going to be the id of the field. The value is what the user has provided and the format of it depends on the fields type.

Variables

name	comment
count	If provided only the count will be returned.
exclude_fields	All the fields are included in the response by default. You can select a subset of fields by providing the exclude_fields query parameter. If you for example provide the following GET parameter `exclude_fields=field_1,field_2` then the fields with id `1` and id `2` are going to be excluded from the selection and response.
filter___field____filter_	The rows can optionally be filtered by the same view filters available for the views. Multiple filters can be provided if they follow the same format. The field and filter variable indicate how to filter and the value indicates where to filter on. For example if you provide the following GET parameter filter__field_1__equal=test then only rows where the value of field_1 is equal to test are going to be returned. The following filters are available: equal, not_equal, filename_contains, has_file_type, contains, contains_not, length_is_lower_than, higher_than, lower_than, date_equal, date_before, date_after, date_not_equal, date_equals_today, date_before_today, date_after_today, date_equals_days_ago, date_equals_months_ago, date_equals_years_ago, date_equals_week, date_equals_month, date_equals_day_of_month, date_equals_year, single_select_equal, single_select_not_equal, link_row_has, link_row_has_not, link_row_contains, link_row_not_contains, boolean, empty, not_empty, multiple_select_has, multiple_select_has_not.
filter_type	`AND`: Indicates that the rows must match all the provided filters. `OR`: Indicates that the rows only have to match one of the filters. This works only if two or more filters are provided.
include	A comma separated list allowing the values of `field_options` which will add the object/objects with the same name to the response if included. The `field_options` object contains user defined view settings for each field. For example the field's width is included in here.
include_fields	All the fields are included in the response by default. You can select a subset of fields by providing the fields query parameter. If you for example provide the following GET parameter `include_fields=field_1,field_2` then only the fields with id `1` and id `2` are going to be selected and included in the response.
limit	Defines how many rows should be returned.
offset	Can only be used in combination with the `limit` parameter and defines from which offset the rows should be returned.
order_by	Optionally the rows can be ordered by provided field ids separated by comma. By default a field is ordered in ascending (A-Z) order, but by prepending the field with a '-' it can be ordered descending (Z-A).
page	Defines which page of rows should be returned. Either the `page` or `limit` can be provided, not both.
search	If provided only rows with data that matches the search query are going to be returned.
size	Can only be used in combination with the `page` parameter and defines how many rows should be returned.
slug	Returns only rows that belong to the related view.

_api_database_views_gallery__view_id___GET : 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 group

_api_database_views_gallery__view_id___GET

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 group. The response is paginated by a limit/offset style.

Variables

name	comment
count	If provided only the count will be returned.
include	A comma separated list allowing the values of `field_options` which will add the object/objects with the same name to the response if included. The `field_options` object contains user defined view settings for each field. For example the field's order is included in here.
limit	Defines how many rows should be returned.
offset	Can only be used in combination with the `limit` parameter and defines from which offset the rows should be returned.
search	If provided only rows with data that matches the search query are going to be returned.
view_id	Returns only rows that belong to the related view's table.

_api_database_views_grid__slug__public_rows__GET : Lists the requested rows of the view's table related to the provided `slug` if the grid view is public

_api_database_views_grid__slug__public_rows__GET

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 provided GET parameters. The properties of the returned rows depends on which fields the table has. For a complete overview of fields use the list_database_table_fields endpoint to list them all. In the example all field types are listed, but normally the number in field_{id} key is going to be the id of the field. The value is what the user has provided and the format of it depends on the fields type.

Variables

name	comment
count	If provided only the count will be returned.
exclude_fields	All the fields are included in the response by default. You can select a subset of fields by providing the exclude_fields query parameter. If you for example provide the following GET parameter `exclude_fields=field_1,field_2` then the fields with id `1` and id `2` are going to be excluded from the selection and response.
filter___field____filter_	The rows can optionally be filtered by the same view filters available for the views. Multiple filters can be provided if they follow the same format. The field and filter variable indicate how to filter and the value indicates where to filter on. For example if you provide the following GET parameter filter__field_1__equal=test then only rows where the value of field_1 is equal to test are going to be returned. The following filters are available: equal, not_equal, filename_contains, has_file_type, contains, contains_not, length_is_lower_than, higher_than, lower_than, date_equal, date_before, date_after, date_not_equal, date_equals_today, date_before_today, date_after_today, date_equals_days_ago, date_equals_months_ago, date_equals_years_ago, date_equals_week, date_equals_month, date_equals_day_of_month, date_equals_year, single_select_equal, single_select_not_equal, link_row_has, link_row_has_not, link_row_contains, link_row_not_contains, boolean, empty, not_empty, multiple_select_has, multiple_select_has_not.
filter_type	`AND`: Indicates that the rows must match all the provided filters. `OR`: Indicates that the rows only have to match one of the filters. This works only if two or more filters are provided.
include	A comma separated list allowing the values of `field_options` which will add the object/objects with the same name to the response if included. The `field_options` object contains user defined view settings for each field. For example the field's width is included in here.
include_fields	All the fields are included in the response by default. You can select a subset of fields by providing the fields query parameter. If you for example provide the following GET parameter `include_fields=field_1,field_2` then only the fields with id `1` and id `2` are going to be selected and included in the response.
limit	Defines how many rows should be returned.
offset	Can only be used in combination with the `limit` parameter and defines from which offset the rows should be returned.
order_by	Optionally the rows can be ordered by provided field ids separated by comma. By default a field is ordered in ascending (A-Z) order, but by prepending the field with a '-' it can be ordered descending (Z-A).
page	Defines which page of rows should be returned. Either the `page` or `limit` can be provided, not both.
search	If provided only rows with data that matches the search query are going to be returned.
size	Can only be used in combination with the `page` parameter and defines how many rows should be returned.
slug	Returns only rows that belong to the related view.

_api_database_views_grid__view_id___GET : 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 group

_api_database_views_grid__view_id___GET

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 group. The response is paginated either by a limit/offset or page/size style. The style depends on the provided GET parameters. The properties of the returned rows depends on which fields the table has. For a complete overview of fields use the list_database_table_fields endpoint to list them all. In the example all field types are listed, but normally the number in field_{id} key is going to be the id of the field. The value is what the user has provided and the format of it depends on the fields type.

The filters and sortings are automatically applied. To get a full overview of the applied filters and sortings you can use the list_database_table_view_filters and list_database_table_view_sortings endpoints.

Variables

name	comment
count	If provided only the count will be returned.
exclude_fields	All the fields are included in the response by default. You can select a subset of fields by providing the exclude_fields query parameter. If you for example provide the following GET parameter `exclude_fields=field_1,field_2` then the fields with id `1` and id `2` are going to be excluded from the selection and response.
include	A comma separated list allowing the values of `field_options` and `row_metadata` which will add the object/objects with the same name to the response if included. The `field_options` object contains user defined view settings for each field. For example the field's width is included in here. The `row_metadata` object includes extra row specific data on a per row basis.
include_fields	All the fields are included in the response by default. You can select a subset of fields by providing the fields query parameter. If you for example provide the following GET parameter `include_fields=field_1,field_2` then only the fields with id `1` and id `2` are going to be selected and included in the response.
limit	Defines how many rows should be returned.
offset	Can only be used in combination with the `limit` parameter and defines from which offset the rows should be returned.
page	Defines which page of rows should be returned. Either the `page` or `limit` can be provided, not both.
search	If provided only rows with data that matches the search query are going to be returned.
size	Can only be used in combination with the `page` parameter and defines how many rows should be returned.
view_id	Returns only rows that belong to the related view's table.

_api_database_views_grid__view_id___POST : Lists only the rows and fields that match the request

_api_database_views_grid__view_id___POST

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 the field_ids are going to be returned. This endpoint could be used to refresh data after changes something. For example in the web frontend after changing a field type, the data of the related cells will be refreshed using this endpoint. In the example all field types are listed, but normally the number in field_{id} key is going to be the id of the field. The value is what the user has provided and the format of it depends on the fields type.

Variables

name	comment
__body
view_id	Returns only rows that belong to the related view's table.

_api_database_views_grid__view_id__aggregation__field_id___GET : Computes the aggregation of all the values for a specified field from the selected grid view

_api_database_views_grid__view_id__aggregation__field_id___GET

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 the selected view, the aggregation is calculated only on filtered rows. You need to have read permissions on the view to request an aggregation.

Variables

name	comment
field_id	The field id you want to aggregate
include	if `include` is set to `total`, the total row count will be returned with the result.
type	The aggregation type you want. Available aggregation types: empty_count, not_empty_count, unique_count, min, max, sum, average, median, decile, variance, std_dev
view_id	Select the view you want the aggregation for.

_api_database_views_grid__view_id__aggregations__GET : Returns all field aggregations values previously defined for this grid view

_api_database_views_grid__view_id__aggregations__GET

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 the view to request aggregations.

Variables

name	comment
include	if `include` is set to `total`, the total row count will be returned with the result.
search	If provided the aggregations are calculated only for matching rows.
view_id	Select the view you want the aggregations for.

_api_database_views_kanban__slug__public_rows__GET : Responds with serialized rows grouped by the view's single select field options related to the `slug` if the kanban view is publicly shared

_api_database_views_kanban__slug__public_rows__GET

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 limit and offset per select option.

This is a premium feature.

Variables

name	comment
limit	Defines how many rows should be returned by default. This value can be overwritten per select option.
offset	Defines from which offset the rows should be returned.This value can be overwritten per select option.
select_option	Accepts multiple `select_option` parameters. If not provided, the rows of all select options will be returned. If one or more `select_option` parameters are provided, then only the rows of those will be included in the response. `?select_option=1&select_option=null` will only include the rows for both select option with id `1` and `null`. `?select_option=1,10,20` will only include the rows of select option id `1` with a limit of `10` and and offset of `20`.
slug	Returns only rows that belong to the related view.

_api_database_views_kanban__view_id___GET : Responds with serialized rows grouped by the view's single select field options if the user is authenticated and has access to the related group

_api_database_views_kanban__view_id___GET

Responds with serialized rows grouped by the view's single select field options if the user is authenticated and has access to the related group. Additional query parameters can be provided to control the limit and offset per select option.

This is a premium feature.

Variables

name	comment
include	Accepts `field_options` as value if the field options must also be included in the response.
limit	Defines how many rows should be returned by default. This value can be overwritten per select option.
offset	Defines from which offset the rows should be returned.This value can be overwritten per select option.
select_option	Accepts multiple `select_option` parameters. If not provided, the rows of all select options will be returned. If one or more `select_option` parameters are provided, then only the rows of those will be included in the response. `?select_option=1&select_option=null` will only include the rows for both select option with id `1` and `null`. `?select_option=1,10,20` will only include the rows of select option id `1` with a limit of `10` and and offset of `20`.
view_id	Returns only rows that belong to the related view's table.

_api_database_views_sort__view_sort_id___DELETE : Deletes the existing sort if the authorized user has access to the related database's group

_api_database_views_sort__view_sort_id___DELETE

Deletes the existing sort if the authorized user has access to the related database's group.

Variables

name	comment
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
view_sort_id	Deletes the sort related to the provided value.

_api_database_views_sort__view_sort_id___GET : Returns the existing view sort if the authorized user has access to the related database's group

_api_database_views_sort__view_sort_id___GET

Returns the existing view sort if the authorized user has access to the related database's group.

Variables

name	comment
view_sort_id	Returns the view sort related to the provided value.

_api_database_views_sort__view_sort_id___PATCH : Updates the existing sort if the authorized user has access to the related database's group

_api_database_views_sort__view_sort_id___PATCH

Updates the existing sort if the authorized user has access to the related database's group.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
view_sort_id	Updates the view sort related to the provided value.

_api_database_views_table__table_id___GET : Lists all views of the table related to the provided `table_id` if the user has access to the related database's group

_api_database_views_table__table_id___GET

Lists all views of the table related to the provided table_id if the user has access to the related database's group. If the group is related to a template, then this endpoint will be publicly accessible. A table can have multiple views. Each view can display the data in a different way. For example the grid view shows the in a spreadsheet like way. That type has custom endpoints for data retrieval and manipulation. In the future other views types like a calendar or Kanban are going to be added. Each type can have different properties.

Variables

name	comment
include	A comma separated list of extra attributes to include on each view in the response. The supported attributes are `filters`, `sortings` and `decorations`. For example `include=filters,sortings` will add the attributes `filters` and `sortings` to every returned view, containing a list of the views filters and sortings respectively.
limit	The maximum amount of views that must be returned. This endpoint doesn't support pagination, but if you for example just need to fetch the first view, you can do that by setting a limit. There isn't a limit by default.
table_id	Returns only views of the table related to the provided value.
type	Optionally filter on the view type. If provided, only views of that type will be returned.

_api_database_views_table__table_id___POST : Creates a new view for the table related to the provided `table_id` parameter if the authorized user has access to the related database's group

_api_database_views_table__table_id___POST

Creates a new view for the table related to the provided table_id parameter if the authorized user has access to the related database's group. Depending on the type, different properties can optionally be set.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
include	A comma separated list of extra attributes to include on each view in the response. The supported attributes are `filters`, `sortings` and `decorations`. For example `include=filters,sortings` will add the attributes `filters` and `sortings` to every returned view, containing a list of the views filters and sortings respectively.
table_id	Creates a view for the table related to the provided value.

_api_database_views_table__table_id__order__POST : Changes the order of the provided view ids to the matching position that the id has in the list

_api_database_views_table__table_id__order__POST

Changes the order of the provided view ids to the matching position that the id has in the list. If the authorized user does not belong to the group it will be ignored. The order of the not provided views will be set to 0.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
table_id	Updates the order of the views in the table related to the provided value.

_api_database_webhooks__webhook_id___DELETE : Deletes the existing webhook if the authorized user has access to the related database's group

_api_database_webhooks__webhook_id___DELETE

Deletes the existing webhook if the authorized user has access to the related database's group.

Variables

name	comment
webhook_id	Deletes the webhook related to the provided value.

_api_database_webhooks__webhook_id___GET : Returns the existing webhook if the authorized user has access to the related database group

_api_database_webhooks__webhook_id___GET

Returns the existing webhook if the authorized user has access to the related database group.

Variables

name	comment
webhook_id	Returns the webhook related to the provided value.

_api_database_webhooks__webhook_id___PATCH : Updates the existing view if the authorized user has access to the related database group

_api_database_webhooks__webhook_id___PATCH

Updates the existing view if the authorized user has access to the related database group.

Variables

name	comment
__body
webhook_id	Updates the webhook related to the provided value.

_api_database_webhooks_table__table_id___GET : Lists all webhooks of the table related to the provided `table_id` if the user has access to the related database group

_api_database_webhooks_table__table_id___GET

Lists all webhooks of the table related to the provided table_id if the user has access to the related database group.

Variables

name	comment
table_id	Returns only webhooks of the table related to this value.

_api_database_webhooks_table__table_id___POST : Creates a new webhook for the table related to the provided `table_id` parameter if the authorized user has access to the related database group

_api_database_webhooks_table__table_id___POST

Creates a new webhook for the table related to the provided table_id parameter if the authorized user has access to the related database group.

Variables

name	comment
__body
table_id	Creates a webhook for the table related to the provided value.

_api_database_webhooks_table__table_id__test_call__POST : This endpoint triggers a test call based on the provided data if the user has access to the group related to the table

_api_database_webhooks_table__table_id__test_call__POST

This endpoint triggers a test call based on the provided data if the user has access to the group related to the table. The test call will be made immediately and a copy of the request, response and status will be included in the response.

Variables

name	comment
__body
table_id	The id of the table that must be tested.

_api_groups__GET : Lists all the groups of the authorized user

_api_groups__GET

Lists all the groups of the authorized user. A group can contain multiple applications like a database. Multiple users can have access to a group. For example each company could have their own group containing databases related to that company. The order of the groups are custom for each user. The order is configurable via the order_groups endpoint.

_api_groups__group_id___DELETE : Deletes an existing group if the authorized user belongs to the group

_api_groups__group_id___DELETE

Deletes an existing group if the authorized user belongs to the group. All the applications, databases, tables etc that were in the group are going to be deleted also.

Variables

name	comment
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
group_id	Deletes the group related to the provided value.

_api_groups__group_id___PATCH : Updates the existing group related to the provided `group_id` parameter if the authorized user belongs to the group

_api_groups__group_id___PATCH

Updates the existing group related to the provided group_id parameter if the authorized user belongs to the group. It is not yet possible to add additional users to a group.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.
group_id	Updates the group related to the provided value.

_api_groups__group_id__leave__POST : Makes the authenticated user leave the group related to the provided `group_id` if the user is in that group

_api_groups__group_id__leave__POST

Makes the authenticated user leave the group related to the provided group_id if the user is in that group. If the user is the last admin in the group, he will not be able to leave it. There must always be one admin in the group, otherwise it will be left without control. If that is the case, he must either delete the group or give another member admin permissions first.

Variables

name	comment
group_id	Leaves the group related to the value.

_api_groups__POST : Creates a new group where only the authorized user has access to

_api_groups__POST

Creates a new group where only the authorized user has access to. No initial data like database applications are added, they have to be created via other endpoints.

Variables

name	comment
__body
__header_ClientSessionId	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.

_api_groups_invitations__group_invitation_id___DELETE : Deletes a group invitation if the authorized user has admin rights to the related group

_api_groups_invitations__group_invitation_id___DELETE

Deletes a group invitation if the authorized user has admin rights to the related group.

Variables

name	comment
group_invitation_id	Deletes the group invitation related to the provided value.

_api_groups_invitations__group_invitation_id___GET : Returns the requested group invitation if the authorized user has admin right to the related group

_api_groups_invitations__group_invitation_id___GET

Returns the requested group invitation if the authorized user has admin right to the related group

Variables

name	comment
group_invitation_id	Returns the group invitation related to the provided value.

_api_groups_invitations__group_invitation_id___PATCH : Updates the existing group invitation related to the provided `group_invitation_id` param if the authorized user has admin rights to the related group

_api_groups_invitations__group_invitation_id___PATCH

Updates the existing group invitation related to the provided group_invitation_id param if the authorized user has admin rights to the related group.

Variables

name	comment
__body
group_invitation_id	Updates the group invitation related to the provided value.

_api_groups_invitations__group_invitation_id__accept__POST : Accepts a group invitation with the given id if the email address of the user matches that of the invitation

_api_groups_invitations__group_invitation_id__accept__POST

Accepts a group invitation with the given id if the email address of the user matches that of the invitation.

Variables

name	comment
group_invitation_id	Accepts the group invitation related to the provided value.

_api_groups_invitations__group_invitation_id__reject__POST : Rejects a group invitation with the given id if the email address of the user matches that of the invitation

_api_groups_invitations__group_invitation_id__reject__POST

Rejects a group invitation with the given id if the email address of the user matches that of the invitation.

Variables

name	comment
group_invitation_id	Rejects the group invitation related to the provided value.

_api_groups_invitations_group__group_id___GET : Lists all the group invitations of the group related to the provided `group_id` parameter if the authorized user has admin rights to that group

_api_groups_invitations_group__group_id___GET

Lists all the group invitations of the group related to the provided group_id parameter if the authorized user has admin rights to that group.

Variables

name	comment
group_id	Returns only invitations that are in the group related to the provided value.

_api_groups_invitations_group__group_id___POST : Creates a new group invitations for an email address if the authorized user has admin rights to the related group

_api_groups_invitations_group__group_id___POST

Creates a new group invitations for an email address if the authorized user has admin rights to the related group. An email containing a sign up link will be send to the user.

Variables

name	comment
__body
group_id	Creates a group invitation to the group related to the provided value.

_api_groups_invitations_token__token___GET : Responds with the serialized group invitation if an invitation with the provided token is found

_api_groups_invitations_token__token___GET

Responds with the serialized group invitation if an invitation with the provided token is found.

Variables

name	comment
token	Returns the group invitation related to the provided token.

_api_groups_order__POST : Changes the order of the provided group ids to the matching position that the id has in the list

_api_groups_order__POST

Changes the order of the provided group ids to the matching position that the id has in the list. If the authorized user does not belong to the group it will be ignored. The order will be custom for each user.

Variables

name	comment
__body
__header_ClientSessionId	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.
__header_ClientUndoRedoActionGroupId	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.

_api_groups_users__group_user_id___DELETE : Deletes a group user if the authorized user has admin rights to the related group

_api_groups_users__group_user_id___DELETE

Deletes a group user if the authorized user has admin rights to the related group.

Variables

name	comment
group_user_id	Deletes the group user related to the provided value.

_api_groups_users__group_user_id___PATCH : Updates the existing group user related to the provided `group_user_id` param if the authorized user has admin rights to the related group

_api_groups_users__group_user_id___PATCH

Updates the existing group user related to the provided group_user_id param if the authorized user has admin rights to the related group.

Variables

name	comment
__body
group_user_id	Updates the group user related to the provided value.

_api_groups_users_group__group_id___GET : Lists all the users that are in a group if the authorized user has admin permissions to the related group

_api_groups_users_group__group_id___GET

Lists all the users that are in a group if the authorized user has admin permissions to the related group. To add a user to a group an invitation must be send first.

Variables

name	comment
group_id	Updates the group user related to the provided value.

_api_jobs__GET : List all existing jobs

_api_jobs__GET

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.

_api_jobs__job_id___GET : Returns the information related to the provided job id

_api_jobs__job_id___GET

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.

Variables

name	comment
job_id	The job id to lookup information about.

_api_jobs__POST : Creates a new job

_api_jobs__POST

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.

Variables

name	comment
__body

_api_licenses__GET : Lists all the valid licenses that are registered to this instance

_api_licenses__GET

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. More information about self hosted licenses can be found on our pricing page https://baserow.io/pricing.

_api_licenses__id___DELETE : Removes the existing license related to the provided parameter

_api_licenses__id___DELETE

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 premium version.

Variables

name	comment
id	The internal identifier of the license, this is `id` and not `license_id`.

_api_licenses__id___GET : Responds with detailed information about the license related to the provided parameter

_api_licenses__id___GET

Responds with detailed information about the license related to the provided parameter.

Variables

name	comment
id	The internal identifier of the license.

_api_licenses__id___user_id___DELETE : Removes the user related to the provided parameter and to the license related to the parameter

_api_licenses__id___user_id___DELETE

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.

Variables

name	comment
id	The internal identifier of the license, this is `id` and not `license_id`.
user_id	The ID of the user that must be removed from the license.

_api_licenses__id___user_id___POST : Adds the user related to the provided parameter and to the license related to the parameter

_api_licenses__id___user_id___POST

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 license.

Variables

name	comment
id	The internal identifier of the license, this is `id` and not `license_id`.
user_id	The ID of the user that must be added to the license.

_api_licenses__id__check__GET : This endpoint checks with the authority if the license needs to be updated

_api_licenses__id__check__GET

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 license has been deleted because there is an instance id mismatch or because it's invalid. In that case a 204 status code is returned.

Variables

name	comment
id	The internal identifier of the license, this is `id` and not `license_id`.

_api_licenses__id__fill_seats__POST : Fills the remaining empty seats of the license with the first users that are found

_api_licenses__id__fill_seats__POST

Fills the remaining empty seats of the license with the first users that are found.

Variables

name	comment
id	The internal identifier of the license, this is `id` and not `license_id`.

_api_licenses__id__lookup_users__GET : This endpoint can be used to lookup users that must be added to a premium license

_api_licenses__id__lookup_users__GET

This endpoint can be used to lookup users that must be added to a premium license. Users that are already in the license are not returned here. Optionally a search query parameter can be provided to filter the results.

Variables

name	comment
id	The internal identifier of the license, this is `id` and not `license_id`.
page	Defines which page of users should be returned.
search	If provided, only users where the name or email contains the value are returned.
size	Defines how many users should be returned per page.

_api_licenses__id__remove_all_users__POST : Removes all the users the users that are on the license

_api_licenses__id__remove_all_users__POST

Removes all the users the users that are on the license. This will empty all the seats.

Variables

name	comment
id	The internal identifier of the license, this is `id` and not `license_id`.

_api_licenses__POST : Registers a new license

_api_licenses__POST

Registers a new license. After registering you can assign users to the license that will be able to use the premium features while the license is active. If an existing license with the same license_id already exists and the provided license has been issued later than that one, the existing one will be upgraded.

Variables

name	comment
__body

_api_row_comments__table_id___row_id___GET : Returns all row comments for the specified table and row

_api_row_comments__table_id___row_id___GET

Returns all row comments for the specified table and row.

Variables

name	comment
limit	Defines how many rows should be returned.
offset	Can only be used in combination with the `limit` parameter and defines from which offset the rows should be returned.
page	Defines which page of rows should be returned. Either the `page` or `limit` can be provided, not both.
row_id	The row to get row comments for.
size	Can only be used in combination with the `page` parameter and defines how many rows should be returned.
table_id	The table the row is in.

_api_row_comments__table_id___row_id___POST : Creates a comment on the specified row

_api_row_comments__table_id___row_id___POST

Creates a comment on the specified row.

Variables

name	comment
__body
row_id	The row to create a comment for.
table_id	The table to find the row to comment on in.

_api_settings__GET : Responds with all the admin configured settings

_api_settings__GET

Responds with all the admin configured settings.

_api_settings_instance_id__GET : Responds with the self hosted instance id

_api_settings_instance_id__GET

Responds with the self hosted instance id. Only a user with staff permissions can request it.

_api_settings_update__PATCH : Updates the admin configured settings if the user has admin permissions

_api_settings_update__PATCH

Updates the admin configured settings if the user has admin permissions.

Variables

name	comment
__body

_api_snapshots__snapshot_id___DELETE : Deletes a snapshot

_api_snapshots__snapshot_id___DELETE

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 permanent and can't be undone.

Variables

name	comment
snapshot_id	Id of the snapshot to delete.

_api_snapshots__snapshot_id__restore__POST : Restores a snapshot

_api_snapshots__snapshot_id__restore__POST

Restores a snapshot. When an application snapshot is restored, a new application will be created in the same group that the original application was placed in with the name of the snapshot and data that were in the original application at the time the snapshot was taken. The original application that the snaphot was taken from is unaffected. Snapshots can be restored multiple times and a number suffix is added to the new application name in the case of a collision.

Variables

name	comment
snapshot_id	Id of the snapshot to restore.

_api_snapshots_application__application_id___GET : Lists snapshots that were created for a given application

_api_snapshots_application__application_id___GET

Lists snapshots that were created for a given application.

Variables

name	comment
application_id	Application ID for which to list snapshots.

_api_snapshots_application__application_id___POST : Creates a new application snapshot

_api_snapshots_application__application_id___POST

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.

Variables

name	comment
__body
application_id	Application ID for which to list snapshots.

_api_templates__GET : Lists all the template categories and the related templates that are in that category

_api_templates__GET

Lists all the template categories and the related templates that are in that category. The template's group_id can be used for previewing purposes because that group contains the applications that are in the template. All the get and list endpoints related to that group are publicly accessible.

_api_templates_install__group_id___template_id___POST : Installs the applications of the given template into the given group if the user has access to that group

_api_templates_install__group_id___template_id___POST

Installs the applications of the given template into the given group if the user has access to that group. The response contains those newly created applications.

Variables

name	comment
group_id	The id related to the group where the template applications must be installed into.
template_id	The id related to the template that must be installed.

_api_trash__GET : Responds with the groups and applications available for the requesting user to inspect the trash contents of

_api_trash__GET

Responds with the groups and applications available for the requesting user to inspect the trash contents of.

_api_trash_group__group_id___DELETE : Empties the specified group and/or application of trash, including the group and application themselves if they are trashed also

_api_trash_group__group_id___DELETE

Empties the specified group and/or application of trash, including the group and application themselves if they are trashed also.

Variables

name	comment
application_id	Optionally filters down the trash to delete to only items for this application in the group.
group_id	The group whose trash contents to empty, including the group itself if it is also trashed.

_api_trash_group__group_id___GET : Responds with trash contents for a group optionally filtered to a specific application

_api_trash_group__group_id___GET

Responds with trash contents for a group optionally filtered to a specific application.

Variables

name	comment
application_id	Optionally filters down the trash to only items for this application in the group.
group_id	Returns the trash for the group with this id.
page	Selects which page of trash contents should be returned.

_api_trash_restore__PATCH : Restores the specified trashed item back into baserow

_api_trash_restore__PATCH

Restores the specified trashed item back into baserow.

Variables

name	comment
__body

_api_user__POST : Creates a new user based on the provided values

_api_user__POST

Creates a new user based on the provided values. If desired an authentication token can be generated right away. After creating an account the initial group containing a database is created.

Variables

name	comment
__body

_api_user_account__PATCH : Updates the account information of the authenticated user

_api_user_account__PATCH

Updates the account information of the authenticated user.

Variables

name	comment
__body

_api_user_change_password__POST : Changes the password of an authenticated user, but only if the old password matches

_api_user_change_password__POST

Changes the password of an authenticated user, but only if the old password matches.

Variables

name	comment
__body

_api_user_dashboard__GET : Lists all the relevant user information that for example could be shown on a dashboard

_api_user_dashboard__GET

Lists all the relevant user information that for example could be shown on a dashboard. It will contain all the pending group invitations for that user.

_api_user_files_upload_file__POST : Uploads a file to Baserow by uploading the file contents directly

_api_user_files_upload_file__POST

Uploads a file to Baserow by uploading the file contents directly. A file multipart is expected containing the file contents.

Variables

name	comment
__header_Authorization
file

_api_user_files_upload_via_url__POST : Uploads a file to Baserow by downloading it from the provided URL

_api_user_files_upload_via_url__POST

Uploads a file to Baserow by downloading it from the provided URL.

Variables

name	comment
__body

_api_user_redo__PATCH : Redoes the latest redoable action performed by the user making the request

_api_user_redo__PATCH

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 ClientSessionId value set on the api request that performed the action will be redone.Additionally the ClientSessionId header must be between 1 and 256 characters long and must only contain alphanumeric or the - characters.

Variables

name	comment
__body
__header_ClientSessionId	The particular client session to redo actions for. The actions must have been performed with this same header set with the same value for them to be redoable by this endpoint.

_api_user_reset_password__POST : Changes the password of a user if the reset token is valid

_api_user_reset_password__POST

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 here without providing the old password.

Variables

name	comment
__body

_api_user_schedule_account_deletion__POST : Schedules the account deletion of the authenticated user

_api_user_schedule_account_deletion__POST

Schedules the account deletion of the authenticated user. The user will be permanently deleted after the grace delay defined by the instance administrator.

Variables

name	comment
__body

_api_user_send_reset_password_email__POST : Sends an email containing the password reset link to the email address of the user

_api_user_send_reset_password_email__POST

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 address is not found. The link is going to the valid for 48 hours.

Variables

name	comment
__body

_api_user_token_auth__POST : Authenticates an existing user based on their username, which is their email address, and their password

_api_user_token_auth__POST

Authenticates an existing user based on their username, which is their email address, and their password. If successful a JWT token will be generated that can be used to authorize for other endpoints that require authorization. The token will be valid for 60 minutes, so it has to be refreshed using the token_refresh endpoint before that time.

Variables

name	comment
__body

_api_user_token_refresh__POST : Refreshes an existing JWT token

_api_user_token_refresh__POST

Refreshes an existing JWT token. If the token is valid, a new token will be included in the response. It will be valid for 60 minutes.

Variables

name	comment
__body

_api_user_token_verify__POST : Verifies if the token is still valid

_api_user_token_verify__POST

Verifies if the token is still valid.

Variables

name	comment
__body

_api_user_undo__PATCH : undoes the latest undoable action performed by the user making the request

_api_user_undo__PATCH

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 ClientSessionId value set on the api request that performed the action will be undone.Additionally the ClientSessionId header must be between 1 and 256 characters long and must only contain alphanumeric or the - characters.

Variables

name	comment
__body
__header_ClientSessionId	The particular client session to undo actions for. The actions must have been performed with this same header set with the same value for them to be undoable by this endpoint.

MediaConnector

MediaConnector

Transactions

Download_HTTP_transaction

Variables

name	comment
__uri

Sequences

AdminLogin : Establishes a session with Baserow

AdminLogin

Establishes a session with Baserow. Must be called before any other API

Variables

name	comment
email	The Base row admin email
password	The baserow admin password

AdminUserCreate : Create a user

AdminUserCreate

Create a user

Variables

name	comment
email
language
name
password

AdminUserDelete : Delete a User

AdminUserDelete

Delete a User

Variables

name	comment
user_id	The id of the user to delete

ApplicationsList : Lists all applications (databases) in baserow

ApplicationsList

Lists all applications (databases) in baserow

AssetFileUpload : Uploads a file asset, the returned link can be used to be set as a value of a 'file' Type cell

AssetFileUpload

Uploads a file asset, the returned link can be used to be set as a value of a 'file' Type cell

Variables

name	comment
apikey	The API Key
file	A File variable holding the path to the file to be uploaded

ClearTableIdCache

ClearTableIdCache

DatabaseTokenCreate : Create a Token to acess databases within a group

DatabaseTokenCreate

Create a Token to acess databases within a group. This token will hold permissions to specific databases in the group

Variables

name	comment
group_id	The ID of the group holding the databases to get a token to (Unique)
name	Token Name

DatabaseTokenDelete : Delete a previously created Token by providing its id

DatabaseTokenDelete

Delete a previously created Token by providing its id

Variables

name	comment
token_id	Deletes the token related to the provided value.

DatabaseTokenList : Create a Token to acess databases within a group

DatabaseTokenList

Create a Token to acess databases within a group. This token will hold permissions to specific databases in the group

FieldsList : Lists all the fields in a baserow table

FieldsList

Lists all the fields in a baserow table

Variables

name	comment
table_id	Returns only the fields of the table related to the provided value.

FieldsListApiKey : Lists all the fields in a baserow table

FieldsListApiKey

Lists all the fields in a baserow table

Variables

name	comment
apikey
table_id	Returns only the fields of the table related to the provided value.

forms_AddRow : Add a row to a Baserow table

forms_AddRow

Add a row to a Baserow table. Each column of the table must have the same name as the technicalID of a field on the form. Forms fields can be any type, but usually select lists are mapped on Baserow Linked Columns.

Variables

name	comment
doc
forms_config	Creates a row in a table with a given configuration
originalDoc

formssource_GetFieldValues : Get all possible values for a given field to feed a Select

formssource_GetFieldValues

Get all possible values for a given field to feed a Select

Variables

name	comment
forms_config	Fills the select component from data with a given configuration. The first column will be the displayed item in the select, the second column will be the value of this item

formssource_GetSelectData : Get data from a Baserow table as options for a Select component

formssource_GetSelectData

Get data from a Baserow table as options for a Select component. You will be able to choose the Baserow columns for the names to be displayed in the select dropdown list and the column for the values of each name.

Variables

name	comment
forms_config	Fills the select component from data with a given configuration. The first column will be the displayed item in the select, the second column will be the value of this item
forms_filter	Filters
forms_Filter	A custom filter following JSON styntax
model	If true, just return one line of data so that No Code studio can compte the table model

formssource_GetTableData : Get data from a Baserow table for a data grid

formssource_GetTableData

Get data from a Baserow table for a data grid. Each column of the Baserow table will be displayed as the same column in the data grid

Variables

name	comment
forms_config	Returns the rows of the table with a given configuration
forms_tableFilter	Filters
model	If true, just return one line of data so that No Code studio can compte the table model

FSExecuteView : Execute a FullSync View

FSExecuteView

Execute a FullSync View

Variables

name	comment
_use_ddoc
_use_descending
_use_endkey
_use_group
_use_group_level
_use_key
_use_limit
_use_reduce
_use_startkey
_use_view

FSPullAndPushTable : Push a BaserowTable to FullSync for offline access

FSPullAndPushTable

Push a BaserowTable to FullSync for offline access

Variables

name	comment
chunkSize
table_id	The table id to create and start an export job for

GroupsList : Lists all Groups for the current user

GroupsList

Lists all Groups for the current user

TableBulkExportToCSV : Exports a Table to CSV

TableBulkExportToCSV

Exports a Table to CSV.. Export status must me monitored with the TableBulkExportWaitFinished sequence

Variables

name	comment
table_id	The table id to create and start an export job for

TableBulkExportWaitFInished : Wait for an export job to be finished

TableBulkExportWaitFInished

Wait for an export job to be finished. Will return the URL to the exported data

Variables

name	comment
job_id	The job id to lookup information about.

TableBulkImportFromCSV : Uploads a CSV to a table

TableBulkImportFromCSV

Uploads a CSV to a table. Each CSV column will be mapped to the existing table Column. If there is more columns in the CSV than in the table additional columns will not be mapped.

Variables

name	comment
chunkSize	The Number of lines imported for each loop
files	List of CSV files to be imported in the table . Can be only one
fileSeparator	The column seperatorr ( , or ; )
firstLineColumn	Set to true if the first CSV lines represents columns names
quoteChar	The character to be used to identify strings ion the CSV file (Usually " but can be ')
table_id	The table ID (Can also be a generic 'Workspace~>Base~>Table' definition)

TableBulkUpdateFromCSV : Updates or inserts data in a Table from a CSV file

TableBulkUpdateFromCSV

Updates or inserts data in a Table from a CSV file. Given a list of column names, the sequence will update all lines from the CSV where the column names will be considered as unique ids. If CSV file contains lines not matching the columns names, they will be added to the table.

Variables

name	comment
chunkSize	The Number of lines imported for each loop
files	List of CSV files to be imported in the table . Can be only one
fileSeparator	The column seperatorr ( , or ; )
firstLineColumn	Set to true if the first CSV lines represents columns names
quoteChar	The character to be used to identify strings ion the CSV file (Usually " but can be ')
table_id	The table ID (Can also be a generic 'Workspace~>Base~>Table' definition)
uniqueFields	List of fields name representing an unique line in the CSV identifying the line to be updated in the table. (Can be only one field)

TableCreateRow : Creates a row in a table

TableCreateRow

Creates a row in a table

Variables

name	comment
before	If provided then the newly created row will be positioned before the row with the provided id.
data	A JSON object with each field name and value
table_id	Insert row in this table_id

TableCreateRowApiKey : Creates a row in a table using an apikey instead of credentials

TableCreateRowApiKey

Creates a row in a table using an apikey instead of credentials

Variables

name	comment
apikey
before	If provided then the newly created row will be positioned before the row with the provided id.
data	A JSON object with each field name and value
table_id	Insert row in this table_id

TableCreateRows : Creates a row in a table

TableCreateRows

Creates a row in a table

Variables

name	comment
data	A JSON object with each field name and value
table_id	Insert row in this table_id

TableCreateRowsApiKey : Creates a row in a table

TableCreateRowsApiKey

Creates a row in a table

Variables

name	comment
apikey
data	A JSON object with each field name and value, such as: {"items" : [{"field1":"value1", "field2": "value2"}, {"field1":"value1B", "field2": "value2B"}]}
table_id	Insert row in this table_id
user_field_names	A flag query parameter which if provided this endpoint will expect and return the user specified field names instead of internal Baserow field names (field_123 etc).

TableCreateView : Creates a new view for the table related

TableCreateView

Creates a new view for the table related

Variables

name	comment
apikey
data
table_id	Insert row in this table_id

TableCreateViewFilter : Updates the existing filter if the authorized user has access to the related database's group

TableCreateViewFilter

Updates the existing filter if the authorized user has access to the related database's group.

Variables

name	comment
apikey
data
table_id	Returns only the fields of the table related to the provided value.
view_id	Creates a filter for the view related to the provided value.

TableDeleteAllRows : Deletes all rows from a table

TableDeleteAllRows

Deletes all rows from a table

Variables

name	comment
chunkSize	The Number of lines deleted for each loop
table_id	The table ID (Can also be a generic 'Workspace~>Base~>Table' definition)

TableDeleteRow : deletes a row from a from a given table

TableDeleteRow

deletes a row from a from a given table

Variables

name	comment
row_id	Deletes the row related to the value.
table_id	Returns the rows of the table related to the provided value.

TableDeleteView : Deletes the existing view if the authorized user has access to the related database's group

TableDeleteView

Deletes the existing view if the authorized user has access to the related database's group. 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 the view.

Variables

name	comment
apikey
view_id	Deletes the view related to the provided value.

TableGetData : Gets data from a given table

TableGetData

Gets data from a given table

Variables

name	comment
describeStructure
exclude	All the fields are included in the response by default. You can select a subset of fields by providing the exclude query parameter. If you for example provide the following GET parameter `exclude=field_1,field_2` then the fields with id `1` and id `2` are going to be excluded from the selection and response. If the `user_field_names` parameter is provided then instead exclude should be a comma separated list of the actual field names. For field names with commas you should surround the name with quotes like so: `exclude=My Field,"Field With , "`. A backslash can be used to escape field names which contain double quotes like so: `exclude=My Field,Field with \"`.
filterExpression	A JSON Structure representing the filters in the form : { "mode": "AND", // Can be AND or OR "filters": [ { "field": "Name", // The name of the column to filter on "op": "contains", // the operation, can be any of the operations described below "value": "Little" // The value of the filter operation }, { "field": "Description", "op": "contains", "value": "1954" } ] } operations Filter Example value Full example equal string field is 'string' not_equal string field is not 'string' date_equal 2020-01-01 field is date '2020-01-01' date_not_equal 2020-01-01 field is not date '2020-01-01' date_equals_today field is today date_before_today field is before today date_after_today field is after today date_equals_days_ago Europe/Paris?1 field is days ago 'Europe/Paris?1' date_equals_months_ago Europe/Paris?1 field is months ago 'Europe/Paris?1' date_equals_years_ago Europe/Paris?1 field is years ago 'Europe/Paris?1' date_equals_week field in this week date_equals_month field in this month date_equals_year field in this year date_equals_day_of_month 1 field day of month is '1' date_before 2020-01-01 field is before date '2020-01-01' date_after 2020-01-01 field is after date '2020-01-01' contains string field contains 'string' filename_contains string field filename contains 'string' has_file_type image / document field has file type 'image / document' contains_not string field contains not 'string' length_is_lower_than 5 field length is lower than '5' higher_than 100 field higher than '100' lower_than 100 field lower than '100' single_select_equal 1 field is '1' single_select_not_equal 1 field is not '1' boolean true field is 'true' link_row_has 1 field has '1' link_row_has_not 1 field has not '1' link_row_contains string field contains 'string' link_row_not_contains string field contains not 'string' multiple_select_has 1 field has '1' multiple_select_has_not 1 field has not '1' empty field is empty not_empty field is not empty
include_fields	All the fields are included in the response by default. You can select a subset of fields by providing the include query parameter. If you for example provide the following GET parameter `include=field_1,field_2` then only the fields withid `1` and id `2` are going to be selected and included in the response. If the `user_field_names` parameter is provided then instead include should be a comma separated list of the actual field names. For field names with commas you should surround the name with quotes like so: `include=My Field,"Field With , "`. A backslash can be used to escape field names which contain double quotes like so: `include=My Field,Field with \"`.
order_by	Optionally the rows can be ordered by provided field ids separated by comma. By default a field is ordered in ascending (A-Z) order, but by prepending the field with a '-' it can be ordered descending (Z-A). If the `user_field_names` parameter is provided then instead order_by should be a comma separated list of the actual field names. For field names with commas you should surround the name with quotes like so: `order_by=My Field,"Field With , "`. A backslash can be used to escape field names which contain double quotes like so: `order_by=My Field,Field with \"`.
page	Defines which page of rows should be returned.
search	If provided only rows with data that matches the search query are going to be returned.
size	Defines how many rows should be returned per page.
table_id	Returns the rows of the table related to the provided value.
view_id	Includes all the filters and sorts of the provided view.

TableGetDataApiKey : Gets data from a given table

TableGetDataApiKey

Gets data from a given table

Variables

name	comment
apikey
exclude	All the fields are included in the response by default. You can select a subset of fields by providing the exclude query parameter. If you for example provide the following GET parameter `exclude=field_1,field_2` then the fields with id `1` and id `2` are going to be excluded from the selection and response. If the `user_field_names` parameter is provided then instead exclude should be a comma separated list of the actual field names. For field names with commas you should surround the name with quotes like so: `exclude=My Field,"Field With , "`. A backslash can be used to escape field names which contain double quotes like so: `exclude=My Field,Field with \"`.
filterExpression	A JSON Structure representing the filters in the form : { "mode": "AND", // Can be AND or OR "filters": [ { "field": "Name", // The name of the column to filter on "op": "contains", // the operation, can be any of the operations described below "value": "Little" // The value of the filter operation }, { "field": "Description", "op": "contains", "value": "1954" } ] } operations Filter Example value Full example equal string field is 'string' not_equal string field is not 'string' date_equal 2020-01-01 field is date '2020-01-01' date_not_equal 2020-01-01 field is not date '2020-01-01' date_equals_today field is today date_before_today field is before today date_after_today field is after today date_equals_days_ago Europe/Paris?1 field is days ago 'Europe/Paris?1' date_equals_months_ago Europe/Paris?1 field is months ago 'Europe/Paris?1' date_equals_years_ago Europe/Paris?1 field is years ago 'Europe/Paris?1' date_equals_week field in this week date_equals_month field in this month date_equals_year field in this year date_equals_day_of_month 1 field day of month is '1' date_before 2020-01-01 field is before date '2020-01-01' date_after 2020-01-01 field is after date '2020-01-01' contains string field contains 'string' filename_contains string field filename contains 'string' has_file_type image / document field has file type 'image / document' contains_not string field contains not 'string' length_is_lower_than 5 field length is lower than '5' higher_than 100 field higher than '100' lower_than 100 field lower than '100' single_select_equal 1 field is '1' single_select_not_equal 1 field is not '1' boolean true field is 'true' link_row_has 1 field has '1' link_row_has_not 1 field has not '1' link_row_contains string field contains 'string' link_row_not_contains string field contains not 'string' multiple_select_has 1 field has '1' multiple_select_has_not 1 field has not '1' empty field is empty not_empty field is not empty
include_fields	All the fields are included in the response by default. You can select a subset of fields by providing the include query parameter. If you for example provide the following GET parameter `include=field_1,field_2` then only the fields withid `1` and id `2` are going to be selected and included in the response. If the `user_field_names` parameter is provided then instead include should be a comma separated list of the actual field names. For field names with commas you should surround the name with quotes like so: `include=My Field,"Field With , "`. A backslash can be used to escape field names which contain double quotes like so: `include=My Field,Field with \"`.
order_by	Optionally the rows can be ordered by provided field ids separated by comma. By default a field is ordered in ascending (A-Z) order, but by prepending the field with a '-' it can be ordered descending (Z-A). If the `user_field_names` parameter is provided then instead order_by should be a comma separated list of the actual field names. For field names with commas you should surround the name with quotes like so: `order_by=My Field,"Field With , "`. A backslash can be used to escape field names which contain double quotes like so: `order_by=My Field,Field with \"`.
page	Defines which page of rows should be returned.
search	If provided only rows with data that matches the search query are going to be returned.
size	Defines how many rows should be returned per page.
table_id	Returns the rows of the table related to the provided value.
view_id	Includes all the filters and sorts of the provided view.

TableGetRowByIdApiKey : Gets data from a given table

TableGetRowByIdApiKey

Gets data from a given table

Variables

name	comment
apikey
row_id	Returns the row related the provided value.
table_id	Returns the rows of the table related to the provided value.

TableGetViews : List all views for the table related

TableGetViews

List all views for the table related

Variables

name	comment
apikey
include	A comma separated list of extra attributes to include on each view in the response. The supported attributes are filters, sortings and decorations. For example include=filters,sortings will add the attributes filters and sortings to every returned view, containing a list of the views filters and sortings respectively.
limit	The maximum amount of views that must be returned. This endpoint doesn't support pagination, but if you for example just need to fetch the first view, you can do that by setting a limit. There isn't a limit by default.
table_id	Returns only views of the table related to the provided value.
type	Optionally filter on the view type. If provided, only views of that type will be returned.

TableReadRow : Reads a row from a from a given table

TableReadRow

Reads a row from a from a given table

Variables

name	comment
row_id	Deletes the row related to the value.
table_id	Returns the rows of the table related to the provided value.

TableUpdateRowApiKey : Updates a row in a table ising apikey instead of credentials

TableUpdateRowApiKey

Updates a row in a table ising apikey instead of credentials

Variables

name	comment
apikey
data
row_id	Insert row in this table_id
table_id	Insert row in this table_id

TokenGetOrRefresh : Gets a token or refresh it if the token is expired the Token will be placed in the current user session

TokenGetOrRefresh

Gets a token or refresh it if the token is expired the Token will be placed in the current user session

Mobile Application

Application

Describes the mobile application global properties

Pages

BrowseTables

My First Page as root page

Shared Components

BaseRowGrid

Provides an infinite paginated Grid that can be fed by data from a BaseRow No Code database.

Variables

name	comment
accessibility	boolean: true (default) or false
ariaLabel
autoSizeColumns
class	One of the themes provided here : https://www.ag-grid.com/javascript-grid-themes-provided/ Also be shure to add the theme in the Theme object as : @import "../../node_modules/ag-grid-community/dist/styles/ag-theme-balham-dark/sass/ag-theme-balham-dark.scss";
defaultColDef	default is {hide: false, editable: true, sortable: true, resizable: true, filter: true, checkboxSelection: false, singleClickEdit: false}
Filters	An JSON object containing the filter to apply to a BaseRow filtered view where each filter is the exact name of the filter variable attached to a filtered list sequence : { filter<And/Or><Column Name 1><Op>: <filter to apply N° 1>, filter<And/Or><Column Name 2><Op>: <filter to apply N° 2> } for example for Sequence GTFSPlacesSmallAirportsList : NB: Be sure to use simple quotes in your JSON structure for strings { filterAndTypeContains: 'small_airport', filterAndIso_countryEqual: 'FR' } Will fill the grid with all records where column Type Contains to small_airports and column Type Contains to Iso_countryEqual equals FR. Filter names will be imported from the No Code Database view.
height	height is 'auto' or value in % or px
id	An Optional ID
ListSequenceName	The BaseRow CRUD "List" sequence name imported from the NoCode View. For example : MyProject.Hotel_BookingsRoomsList Where MyProject is the name of the project holding the Sequence and Hotel_BookingsRoomsList is the name of the Sequence in this project.
overlayLoadingTemplate
overlayNoRowsTemplate
paginationPageSize	integer: 10 by default
rowDeselection	boolean: true (default) or false
rowHeight	Height of the row in pixels as a string
rowSelection	string: 'single' (default) or 'multiple'
Search	Will only return data that matches this search whatever the column is
suppressCellSelection
suppressRowClickSelection
width	width value in % or px
wrapperClass	Height of the row in pixels as a string