Database table rows

Changed on

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.

get/api/database/rows/table/{table_id}/{row_id}/adjacent/

Request

  • Base URL
    https://api.baserow.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.baserow.io/api/database/rows/table/{table_id}/{row_id}/adjacent/
  • Auth
    HTTP bearer

Path parameters

row_idinteger required

Returns the row adjacent the provided value.

table_idinteger required

Returns the row of the table related to the provided value.

Query parameters

previousboolean

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.

searchstring

If provided, the adjacent row will be one that matchesthe search query.

search_modestring

If provided, allows API consumers to determine what kind of search experience they wish to have. If the default SearchMode.FT_WITH_COUNT is used, then Postgres full-text search is used. If SearchMode.COMPAT is provided then the search term will be exactly searched for including whitespace on each cell. This is the Baserow legacy search behaviour.

user_field_namesboolean

A flag query parameter that, if provided with one of the following values: y, yes, true, t, on, 1, or an empty value, will cause the returned JSON to use the user-specified field names instead of the internal Baserow field names (e.g., field_123).

view_idinteger

Applies the filters and sorts of the provided view.

Response

idinteger required

The unique identifier of the row in the table.

orderstring decimal

Indicates the position of the row, lowest first and highest last.

field_1string nullable

This field represents the text field. The number in field_1 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_2string nullable

This field represents the long_text field. The number in field_2 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_3string nullable

This field represents the url field. The number in field_3 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_4string nullable

This field represents the email field. The number in field_4 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_5string decimal nullable

This field represents the number field. The number in field_5 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_6integer

This field represents the rating field. The number in field_6 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_7boolean

This field represents the boolean field. The number in field_7 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_8string date nullable

This field represents the date field. The number in field_8 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_9string date-time

This field represents the last_modified field. The number in field_9 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_11string date-time

This field represents the created_on field. The number in field_11 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_13number float nullable

This field represents the duration field. The number in field_13 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field. The provided value can be a string in one of the available formats or a number representing the duration in seconds. In any case, the value will be rounded to match the field's duration format.

field_18string nullable

This field represents the phone_number field. The number in field_18 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_19string nullable

This field represents the formula field. The number in field_19 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_20string nullable

This field represents the count field. The number in field_20 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_21string nullable

This field represents the rollup field. The number in field_21 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_22string nullable

This field represents the lookup field. The number in field_22 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_24string uuid

This field represents the uuid field. The number in field_24 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field. Contains a unique and persistent UUID for every row.

field_25integer

This field represents the autonumber field. The number in field_25 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field. Contains a unique and persistent incremental integer number for every row.

field_26boolean

This field represents the password field. The number in field_26 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field. Allows setting a write only password value. Providing a string will set the password, null will unset it, true will be ignored. The response will respond with true is a password is set, but will never expose the password itself.

field_27string required

This field represents the form_view_edit_row field. The number in field_27 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_28string nullable

This field represents the button field. The number in field_28 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_29string nullable

This field represents the ai field. The number in field_29 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field. Holds a value that is generated by a generative AI model using a dynamic prompt.

Changes

  • e81714236040Revision changes
    • info

      the endpoint scheme security UserSource JWT was removed from the API

  • 0c490e5b0c7fRevision changes
    • breaking

      the response property's maxLength was unset from 1000000 for the response status

    • info

      added the optional property to the response with the status