GIgitlab
groups

List all billable group members

Lists all billable members of a specified top-level group. Includes members in any subgroups or projects. You must have the Owner role for the group.

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

Request

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

Path parameters

idstring required

The ID of a group

Query parameters

pageinteger

Current page number

per_pageinteger

Number of items per page

searchstring

The exact name of the subscribed member

sort'access_level_asc' | 'access_level_desc' | 'last_joined' | 'name_asc' | 'name_desc' | 'oldest_joined' | 'oldest_sign_in' | 'recent_sign_in' | 'last_activity_on_asc' | 'last_activity_on_desc'

The sorting option

Response

List all billable group members

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.