Generate a list of groups. Include any child groups as a part of the list

GET /groups/flatlist/{limit}/{limitvalue}

This outputs a list of each group. Child groups are included as part of the list

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 name: The name (case insentive) for a specific group

    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

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • groups array[object]
      Hide groups attributes Show groups attributes object
      • id integer
      • name string
      • group_type object

        Additional properties are allowed.

        Hide group_type attributes Show group_type attributes object
        • id integer
        • name string
      • locked string

        Whether this group is locked to administrators only

        Values are Y or N.

      • can_see_content string

        Values are Y or N.

      • can_do_tasks string

        Values are Y or N.

      • membership object

        The membership level the logged in user has in this group

        Additional properties are allowed.

        Hide membership attributes Show membership attributes object
        • code string

          Values are A, F, V, or P.

        • text string

          Values are Administrator, Full member, View only, or Past member.

      • use_as_visible_to string

        Values are Y or N.

    • total_top_level_groups_shown integer
    • total_groups_shown integer
GET /groups/flatlist/{limit}/{limitvalue}
curl \
 --request GET 'https://YOURSITE.infoodle.com/apiv2/groups/flatlist/parent, visible/310, Y' \
 --header "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"
    }
  ],
  "total_top_level_groups_shown": 1,
  "total_groups_shown": 5
}