Skip to main content

List groups

GET 
/groups

Allows retrieving group directly by a group ID or by looking up a client. When retrieving a group, all his associated information such as their custom field values and addresses may also be returned if requested. An empty list is returned if no groups are found.

Get all groups assigned to the branch with id DB

GET /api/groups/?branchId=DB

Get all groups assigned to the centre with id DB and provide full details

GET /api/groups/?centreId=DC&fullDetails=true

Request​

Responses​

ok