GET
/
v1
/
groups
{
  "groups": [
    {
      "name": "<string>",
      "title": "<string>",
      "description": "<string>",
      "members": [
        {
          "member": "<string>",
          "role": "ROLE_UNSPECIFIED"
        }
      ],
      "source": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Query Parameters

​
pageSize
integer

The maximum number of groups to return. The service may return fewer than this value. If unspecified, at most 10 groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

​
pageToken
string

A page token, received from a previous ListGroups call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListGroups must match the call that provided the page token.

​
filter
string

Filter is used to filter groups returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec

Supported filter:

  • title: the group title, support "==" and ".matches()" operator.
  • email: the group email, support "==" and ".matches()" operator.
  • project: the project full name in "projects/{id}" format, support "==" operator.

For example: title == "dba" email == "dba@bytebase.com" title.matches("dba") email.matches("dba") project == "projects/sample-project" You can combine filter conditions like: title.matches("dba") || email.matches("dba")

Response

OK

​
groups
object[]

The groups from the specified request.

​
nextPageToken
string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.