WorkSmart Dev
HomeSign In
  • Introduction
  • REST Web API
    • Oauth 2.0 Authorization
      • Authorization Code Flow
      • Token (Auth Code Flow)
      • Token (Client Credentials)
    • Records
      • Create Record
      • Read Record
      • Update Record
      • Delete Record
      • Read Records By View
      • Add Comment
      • Add Attachment
      • Download Attachment
    • List Sites
    • Columns
      • List of Columns
  • Webhook
    • Configure a Webhook
Powered by GitBook
On this page
  • Filter Parameters (Optional) :
  • Sample Request
  • Sample Response

Was this helpful?

  1. REST Web API
  2. Records

Read Records By View

Get all records by a specific view:

URL : /api/v1/app/{app_id}/view/{view_id} Method : GET

Parameters:

access_token (required, header parameter) Send this as header – e.g.“Authorization: Bearer access_token”

app_id (required, header parameter) Application Id

view_id (required, header parameter) View Id

Filter Parameters (Optional) :

Method – GET – for filtering data

filter_columns Column Ids. To filter data for multiple columns, use “|” as separator e.g. filter_columns=2|3|4

filter_values Values that needs to be matched. To filter data using multiple values, use “|” as separator e.g. filter_columns=2|2|4and filter_values=Column2Text1|Column2Text2|Column4

filter_apps App Ids for the columns (only applicable for columns from Lookup App). To filter data using multiple apps, use “|” as separator

filter_operators Operators to use for filtering data. To use multiple operators, use “|” as separator e.g. filter_operators=0|0|1.

Operator codes are as below:

0 : contains

1 : does not contain

2 : equals

3 : does not equal

4 : empty

5 : not empty

6 : less than

7 : less than or equal to

8 : greater than

9 : greater than or equal to

Sample Request

curl -H "Authorization: Bearer {access_token}" https://my.worksmart.app/api/v1/app/123/view/456

Sample Response

{
   "data":[
      {
         "a30":"DEMO00000"
      },
      {
         "a30":"DEMO00002"
      }
   ],
   "metadata":[
      {
         "view_id":"456",
         "field_id_in_data":"a30",
         "field_name":"Title",
         "field_description":"",
         "app_id":"123",
         "id":"1",
         "type_name":"Auto Number"
      }
   ]
}
PreviousDelete RecordNextAdd Comment

Last updated 3 years ago

Was this helpful?