Interface SearchUsersParams

Parameters for the searchUsers function.

interface SearchUsersParams {
    beneficiaryId?: string;
    createdFrom?: number;
    createdTo?: number;
    name?: string;
    pageKeyMap?: string;
    phone?: string;
    sortDesc?: boolean;
    sortOrder?: "name" | "created" | "updated";
    updatedFrom?: number;
    updatedTo?: number;
}

Properties

beneficiaryId? createdFrom? createdTo? name? pageKeyMap? phone? sortDesc? sortOrder? updatedFrom? updatedTo?

Properties

OptionalbeneficiaryId

beneficiaryId?: string

Unique id of related Beneficiary record.

OptionalcreatedFrom

createdFrom?: number

Unix ms timestamp of earliest created value.

OptionalcreatedTo

createdTo?: number

Unix ms timestamp of latest created value.

Optionalname

name?: string

First characters of either first or last name. Case, whitespace & diacritic insensitive.

OptionalpageKeyMap

pageKeyMap?: string

Page key map from previous search page.

Optionalphone

phone?: string

First characters of phone number. Case, whitespace & diacritic insensitive.

OptionalsortDesc

sortDesc?: boolean

Sort results in descending order if true.

OptionalsortOrder

sortOrder?: "name" | "created" | "updated"

Sort order of results. Default reflects search params, created if none.

OptionalupdatedFrom

updatedFrom?: number

Unix ms timestamp of earliest updated value.

OptionalupdatedTo

updatedTo?: number

Unix ms timestamp of latest updated value.

Settings

On This Page

Properties