NameDescriptionTypeAdditional information
Hakusana Hakusana, joka saa sisältää maksimissaan kolme termiä, esimerkiksi nimeä. Hakusanalla voi hakea asukkaita nimen, sähköpostin, matkapuhelinnumeron tai puhelinnumeron mukaan. string String length: inclusive between 3 and 50
KohdeId Haetaan kohteen tai sen alla olevien kohteiden asukkaita. integer None.
Take Suodatetaan asukkaiden hakutulosten enimmäismäärä. Palauttaa maksimissaan 50 hakutulosta. integer None.
Sort Järjestelee hakutuloksen annetun parametrin mukaisesti, esimerkiksi osapuolen nimen mukaisesti. ApiAsukasSort None.
Order Määrittelee hakutuloksen järjestyksen nousevasti tai laskevasti. ApiSortOrder None.