Get List of Groups

Returns list of groups.

Role

Administrator 
Project Administrator 

Method

GET 

URL

/api/v2/groups 

Query parameters

Parameter Name Type Description
order String “asc” or “desc” default=“desc”
offset Number
count Number number of records to retrieve(1-100) default=20

Response example

Status Line / Response Header

HTTP/1.1 200 OK 
Content-Type:application/json;charset=utf-8 

Response Body

[ 
    { 
        "id": 1, 
        "name": "test", 
        "members": [ 
            { 
                "id": 2, 
                "userId": "developer", 
                "name": "developer", 
                "roleType": 2, 
                "lang": null, 
                "nulabAccount": {
                    "nulabId": "wZmTYcgsR75zebBQpyYRNES4cBZySC5rRizXxNeLJ83swN4nrS",
                    "name": "developer",
                    "uniqueId": "developer"
                },
                "mailAddress": "developer@nulab.example",
                "lastLoginTime": "2022-09-01T06:35:39Z"
            } 
        ], 
        "displayOrder": null, 
        "createdUser": { 
            "id": 1, 
            "userId": "admin", 
            "name": "admin", 
            "roleType": 1, 
            "lang": "ja", 
            "nulabAccount": {
                "nulabId": "Prm9ZD9DQD5snNWcSYSwZiQoA9WFBUEa2ySznrSnSQRhdC2X8G",
                "name": "admin",
                "uniqueId": "admin"
            },
            "mailAddress": "eguchi@nulab.example",
            "lastLoginTime": "2022-09-01T06:35:39Z"
        }, 
        "created": "2013-05-30T09:11:36Z", 
        "updatedUser": { 
            "id": 1, 
            "userId": "admin", 
            "name": "admin", 
            "roleType": 1, 
            "lang": "ja", 
            "nulabAccount": {
                "nulabId": "Prm9ZD9DQD5snNWcSYSwZiQoA9WFBUEa2ySznrSnSQRhdC2X8G",
                "name": "admin",
                "uniqueId": "admin"
            },
            "mailAddress": "eguchi@nulab.example",
            "lastLoginTime": "2022-09-01T06:35:39Z"
        }, 
        "updated": "2013-05-30T09:11:36Z" 
    }, 
    ... 
]