Search for groups

POST 
/groups/search

Allows you to retrieve groups using dynamic custom filters.

Available group filter values

Filter Selection Parameter	Data Type
CLIENT_ROLE_KEY	KEY
BRANCH_KEY	KEY
CENTRE_KEY	KEY
CREDIT_OFFICER_KEY	KEY
ENCODED_KEY	KEY
GROUP_NAME	STRING
CREATION_DATE	DATE_UTC
LAST_MODIFIED_DATE	DATE_UTC
ID	STRING
PREFERRED_LANGUAGE	ENUM
DEPOSITS_BALANCE	MONEY
LOANS_BALANCE	MONEY
TOTAL_BALANCE	MONEY
NUMBER_OF_MEMBERS	NUMBER
LOAN_CYCLE	NUMBER

Available filter elements

Filter Element	Number Of affected values	Available for
EQUALS	ONE_VALUE	BIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY
MORE_THAN	ONE_VALUE	BIG_DECIMAL,NUMBER,MONEY
LESS_THAN	ONE_VALUE	BIG_DECIMAL,NUMBER,MONEY
BETWEEN	TWO_VALUES	BIG_DECIMAL,NUMBER,MONEY,DATE,DATE_UTC
ON	ONE_VALUE	DATE,DATE_UTC
AFTER	ONE_VALUE	DATE,DATE_UTC
BEFORE	ONE_VALUE	DATE,DATE_UTC
STARTS_WITH	ONE_VALUE	STRING
IN	LIST	ENUM,KEY
TODAY	NO_VALUE	DATE,DATE_UTC
THIS_WEEK	NO_VALUE	DATE,DATE_UTC
THIS_MONTH	NO_VALUE	DATE,DATE_UTC
THIS_YEAR	NO_VALUE	DATE,DATE_UTC
LAST_DAYS	ONE_VALUE	DATE,DATE_UTC
EMPTY	NO_VALUE	BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC
NOT_EMPTY	NO_VALUE	BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC

Request

Responses

200

ok