@makehq/sdk
    Preparing search index...

    Type Alias ListDataTableRecordsOptions

    Options for listing or searching data table records.

    The data table service uses page-based pagination (limit/page) instead of the SDK's shared offset-based Pagination type.

    type ListDataTableRecordsOptions = {
        filter?: string | DataTableFilter;
        keys?: string[];
        limit?: number;
        page?: number;
        query?: string;
        sortBy?: string;
        sortDir?: "asc" | "desc";
    }
    Index

    Properties

    filter? keys? limit? page? query? sortBy? sortDir?

    Properties

    filter?: string | DataTableFilter

    Filter-mode filter to restrict the returned records; a DataTableFilter is serialized into the JSON query parameter automatically, a string is passed through as-is

    keys?: string[]

    Restrict the result to specific record keys

    limit?: number

    Maximum number of records to return

    Optionalpage

    page?: number

    Page number to return (1-based)

    query?: string

    Query-mode expression to search records

    sortBy?: string

    Column to sort results by

    sortDir?: "asc" | "desc"

    Sort direction (ascending or descending)

    Settings

    Member Visibility

    On This Page

    Properties