Sign in
Groups

Get A Group

Returns the full detail record for a single group, including its parent group and any direct child (sub)groups. Use this endpoint to inspect a group's hierarchy and metadata before modifying its membership or settings.

get/groups/{id}

Path parameters

idinteger required

VOMO Group ID

Response

Returns the group record, including its parent group (if any) and any direct child subgroups.

Example response

{
  "data": {
    "name": "Afternoon Team",
    "description": "This team will take over for the morning team at 12pm",
    "has_subgroups": true,
    "subgroups": [
      {
        "name": "Afternoon Team",
        "description": "This team will take over for the morning team at 12pm",
        "has_subgroups": true,
        "created_at": "2016-03-07T07:49:41+00:00",
        "updated_at": "2016-03-07T07:49:41+00:00"
      }
    ],
    "parent": {
      "name": "Afternoon Team",
      "description": "This team will take over for the morning team at 12pm",
      "has_subgroups": true,
      "created_at": "2016-03-07T07:49:41+00:00",
      "updated_at": "2016-03-07T07:49:41+00:00"
    },
    "created_at": "2016-03-07T07:49:41+00:00",
    "updated_at": "2016-03-07T07:49:41+00:00"
  }
}

Changes