Generate a list of groups. Include any child groups as nested arrays of child groups

GET /groups/list/{limit}/{limitvalue}
Oauth security

This outputs a list of each group and their child groups nested within each object.

Path parameters

  • limit string Required

    A comma list of the limit options. If supplied must have the same comma options as the limitvalues parameter. group_type: The ID of the group type parent: Integer. The ID of the parent group to start the search from. action: Either Y or N visible: Either Y or N content: Either Y or N

    Values are group_type, parent, action, visible, or content.

  • limitvalue string Required

    A comma list of the limit values. If supplied must have the same comma options as the limit parameter.

Responses

GET /groups/list/{limit}/{limitvalue} 
curl \
 -X GET https://YOURSITE.infoodle.com/apiv2/groups/list/parent, visible/310, Y \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "groups": [
    {
      "id": 498,
      "name": "Newsletter Mailing List",
      "group_type": {
        "id": 13,
        "name": "Contact & Newsletters"
      },
      "locked": "N",
      "can_see_content": "N",
      "can_do_tasks": "N",
      "membership": {
        "code": "A",
        "text": "Administrator"
      },
      "use_as_visible_to": "N",
      "child_groups": []
    }
  ],
  "total_top_level_groups_shown": 1,
  "total_groups_shown": 5
}