latestOpenAPI 3.1.02026-08-085123123.9 KB

bf0b51ee8e8a

Groups

Retrieve groups

Retrieve a paginated list of groups.

get/groups

Query parameters

pageinteger

The page of results to view

limitinteger

The number of results per page (max 10 000)

sort'group_asc' | 'group_desc' | 'nbmember_asc' | 'nbmember_desc' | 'type_asc' | 'type_desc' | 'nbnewsletter_asc' | 'nbnewsletter_desc' | 'date_asc' | 'date_desc'

Sort order for results

Response

Paginated list of groups

totalCountinteger
pageinteger
limitinteger
sortstring

Example response

{
  "groups": [
    {
      "id": 159872,
      "title": "Testing Group 1",
      "membersCount": 12,
      "createdOn": "2014-12-09 13:48:44.887"
    }
  ],
  "totalCount": 94,
  "page": 1,
  "limit": 2
}