GIgitlab
members

List all direct members of a group

Lists all direct members of a specified group viewable by the authenticated user. Does not return inherited members from ancestor groups or invited groups.

get/api/v4/groups/{id}/members

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idstring required

The group ID

Query parameters

querystring

A query string to search for members

user_idsinteger[]

Array of user ids to look up for membership

skip_usersinteger[]

Array of user ids to be skipped for membership

show_seat_infoboolean

Show seat information for members

with_saml_identityboolean

List only members with linked SAML identity

pageinteger

Current page number

per_pageinteger

Number of items per page

Response

List all direct members of a group

idinteger required
usernamestring required
public_emailstring required
namestring required
statestring required
lockedboolean required
avatar_urlstring required
avatar_pathstring
web_urlstring required
access_levelstring required
created_atstring required
expires_atstring required
two_factor_enabledboolean
emailstring
is_using_seatstring
overridestring
membership_statestring required

Example response

[
  {
    "id": 1,
    "username": "admin",
    "public_email": "john@example.com",
    "name": "Administrator",
    "state": "active",
    "avatar_url": "https://gravatar.com/avatar/1",
    "avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
    "custom_attributes": [
      {
        "key": "foo",
        "value": "bar"
      }
    ],
    "web_url": "https://gitlab.example.com/root",
    "created_by": {
      "id": 1,
      "username": "admin",
      "public_email": "john@example.com",
      "name": "Administrator",
      "state": "active",
      "avatar_url": "https://gravatar.com/avatar/1",
      "avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
      "custom_attributes": [
        {
          "key": "foo",
          "value": "bar"
        }
      ],
      "web_url": "https://gitlab.example.com/root"
    },
    "member_role": {
      "id": 2,
      "group_id": 2,
      "name": "Custom guest",
      "description": "Guest user who can also read_code",
      "base_access_level": 40
    }
  }
]

Changes

No recorded changes to this operation across all 5 revisions of this API.