v1

latestOpenAPI 3.0.12026-08-0640103344.9 KB

Group

Get Groups

Retrieves a paginated list of groups associated with a specific orgunit. Supports comprehensive server-side filtering, text searching, and categorical lookups.

get/orgunit/{orgunitId}/groups

Path parameters

orgunitIdstring required

orgunitId

Query parameters

pageNumberinteger required

Specifies the page index of the results to retrieve. Must be greater than or equal to 1.

pageSizeinteger required

Controls the maximum number of groups returned per page. Accepts values between 1 and 1000.

searchstring

Filters the groups by matching alphanumeric characters against the group name or keyword or tags based on searchCategory.

isDialogueboolean

Filters results based on whether two-way interactive messaging (inbox) is enabled for the group.

searchCategory'Group' | 'Keyword' | 'Tag'

Narrows down the group search context by a specific predefined category.

groupType'All' | 'Public' | 'Info' | 'Whatsapp'

Filters the list by the designated group operational mode. Accepted values include Public(Subscription), Info, or Whatsapp.

defaultTagboolean

queryOperator'Any' | 'All'

Specifies the logical evaluation behavior (e.g., AND, OR) applied when combining multiple filtering criteria. Any is used to get result when any of the given matches, All is used to get result when all search is matched.

Response

Success

appCodestring nullable

messagestring nullable

isErrorboolean