Retrieve Records

You can retrieve all of a table's records, or get a specific record by it's unique ID.

Get Record

Get a Record in a specified Table.

get_record(tableId: string, recordId: string, options?: GetRecordOptions): Promise<SimpleRecord>;

Parameter Name	Type	Description
tableId	string	The Id of the Table to get the record from.
recordId	string	A record Id.
options	object	Get record options.

Example Script - Get Record

  <!--get_record appId: string, recordId: string, options?: GetRecordOptions-->

  <script>
    window.SmartSuite.get_record('67161745a504292e31e25ad5', '6740a4eb96b9e63d42ff9fed').then(
      (res) => {
        console.log('result =>>>', res);
      }
    );
  </script>

List Records

Gets Records from a specified Table.

list_records( appId: ID, options?: ListRecordsOptions | GroupFilter): Promise<SimpleRecordList>;

Parameter Name	Type	Description
tableId	string	The Id of the Table to get the records from.
listRecordsOptions	object	List records options.

ListRecordOptions

export interface RecordOptions {
  skipValidation?: boolean;
}

GroupFilter

The GroupFilter object is identical to the filters defined in SmartSuite's API. Please refer to the Filter Syntax documentation.

Example Script - List Records

<!--list_records( appId: ID, options?: ListRecordsOptions | GroupFilter): Promise<SimpleRecordList>;-->

<script>
  window.SmartSuite.list_records('673635639c6c4519fd0d7be6', {
    filter: {
      operator: "and",
      fields: [{
        comparison: "has_any_of",
        field: "title",
        value: ["1212"],
      }
      ]
    }
  }).then((res) => {
    console.log('result =>>>', res);
  });
</script>