retable faq blue background
January 20, 2024
API

How to use search function for API

Retable's API search function helps you to get specific information about a specific Retable

The response is going to be row data which is exactly the same as the term. Term parameter accepts input with space. Example requests and responses are given below.

https://api.retable.io/v1/public/retable/jKN7x47LLjHZcXAv/search?column_id=eLfL2NyPMPrviXbn&term=Red%Rose%

{
   "data": {
       "rows": [
           {
               "row_id": 4,
               "created_at": "2023-08-03 10:08:01",
               "updated_at": "2023-08-15 11:01:47",
               "created_by": {
                   "id": "lQ2vhlFYlgrXkAGe",
                   "name": "John",
                   "surname": "Doe",
                   "email": "johndoe@retable.io"
               },
               "updated_by": {
                   "id": "lQ2vhlFYlgrXkAGe",
                   "name": "John",
                   "surname": "Doe",
                   "email": "johndoe@retable.io"
               },
               "columns": [
                   {
                       "column_id": "eLfL2NyPMPrviXbn",
                       "title": "Name",
                       "cell_value": "Red Rose"
                   }
               ]
           },
           {
               "row_id": 5,
               "created_at": "2023-08-03 16:08:01",
               "updated_at": "2023-08-15 17:01:47",
               "created_by": {
                   "id": "lQ2vhlFYlgrXkAGe",
                   "name": "John",
                   "surname": "Doe",
                   "email": "johndoe@retable.io"
               },
               "updated_by": {
                   "id": "lQ2vhlFYlgrXkAGe",
                   "name": "John",
                   "surname": "Doe",
                   "email": "johndoe@retable.io"
               },
               "columns": [
                   {
                       "column_id": "eLfL2NyPMPrviXbn",
                       "title": "Name",
                       "cell_value": "Red Rose"
                   }
               ]
           }
       ]
   }
}

Check our detailed API documentation to learn more!