@maschinenlesbar.org/abgeordnetenwatch-cli
    Preparing search index...

    Interface ListParams

    Parameters for a collection request.

    interface ListParams {
        filters?: Record<string, string | number | boolean>;
        rangeEnd?: number;
        rangeStart?: number;
        sortBy?: string;
        sortDirection?: "asc" | "desc";
    }
    Index
    filters? rangeEnd? rangeStart? sortBy? sortDirection?
    filters?: Record<string, string | number | boolean>

    Arbitrary field filters, merged verbatim into the query string. Keys may use the bracket-operator form, e.g. { "year_of_birth[gt]": 1990, sex: "f" }. Pass a related entity's id directly, e.g. { politician: 184945 }.

    rangeEnd?: number

    Page size — number of items to return. The API honours this up to 1000; a value above 1000 is ignored and it falls back to its default page size (100).

    rangeStart?: number

    0-based offset of the first item to return.

    sortBy?: string

    Field name to sort by (e.g. last_name, id).

    sortDirection?: "asc" | "desc"

    Sort order.

    Settings
    Member Visibility

    On This Page
    Properties