Database table grid view

Changed on

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.

post/api/database/views/grid/{view_id}/

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/views/grid/{view_id}/
  • Auth
    HTTP bearer

Path parameters

view_idinteger required

Returns only rows that belong to the related view's table.

Request body

field_idsinteger[]

Only the fields related to the provided ids are added to the response. If None are provided all fields will be returned.

row_idsinteger[] required

Only rows related to the provided ids are added to the response.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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.

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.

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.

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.

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

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.

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