Skip to main content

GetGroup

Get group information

Description​

Obtains information on a specified group and a list of groups.

Method​

GET

Request URL Format​

/api/v0/groups/:group-id
  • :group-id can be omitted. If omitted, TOP group information is returned.

Request URL Sample​

GET https://api.xxx.com/api/v0/groups

Response Sample​

{
    "error": "",
    "group": {
        "g_id": "親グループID",
        "group_id": "親グループのDISPLAY_ID",
        "name": "親グループ名",
        "index": 0　//("Parent Group Position")
    },
    "children": [], //("Group ID of subordinate group")
    "count": 0 //(The number of members in the parent group)
}

Request Sample2​

GET https://api.xxx.com/api/v0/groups/5c5fd6c084f4be2574e2bcb2

Response Sample2​

{
    "error": "",
    "group": {
        "g_id": "親グループID",
        "group_id": "親グループのDISPLAY_ID",
        "name": "親グループ名",
        "index": 0 // ("Parent Group Position")
    },
    "children": [
        {
            "g_id": "配下グループID",
            "group_id": "配下グループのDISPLAY_ID",
            "name": "配下グループ名,　例：事業部A2",
            "index": 0 // ("Subordinate group position")
        },
        {
            "g_id": "配下グループID",
            "group_id": "配下グループのDISPLAY_ID",
            "name": "配下グループ名,　例：事業部A2",
            "index": 1// ("Subordinate group position")
        }
    ],
    "count": 2 // ("Number of subordinates in parent group")
}