retrieve
abstract suspend fun retrieveAll24(officeId: Long? = null, staffId: Long? = null, externalId: String? = null, name: String? = null, underHierarchy: String? = null, paged: Boolean? = null, offset: Int? = null, limit: Int? = null, orderBy: String? = null, sortOrder: String? = null, orphansOnly: Boolean? = null): GetGroupsResponse
List Groups The default implementation of listing Groups returns 200 entries with support for pagination and sorting. Using the parameter limit with description -1 returns all entries. Example Requests: groups groups?fields=name,officeName,joinedDate groups?offset=10&limit=50 groups?orderBy=name&sortOrder=DESC Responses:
200: OK
Return
Parameters
office
officeId (optional)
staff
staffId (optional)
external
externalId (optional)
name
name (optional)
under
underHierarchy (optional)
paged
paged (optional)
offset
offset (optional)
limit
limit (optional)
order
orderBy (optional)
sort
sortOrder (optional)
orphans
orphansOnly (optional)