v2

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-07-21130282381.6 KB
Groups

Search for groups using filters

Search for groups using filters

Search for groups using filters.

post/environments/{envId}/groups/_search

Query parameters

pageinteger

The page number for pagination.

perPageinteger

The number of items per page for pagination.

Request body

idsstring[]

List of group IDs to search for.

Response

Page of Groups

metadataResponseMetadata

Generic object to handle additional information about an entity. Can also be used for pagination data.

Example response

{
  "data": [
    {
      "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
      "name": "Gravitee group",
      "createdAt": "2018-11-23 22:00:00+00:00",
      "updatedAt": "2018-11-23 22:00:00+00:00"
    }
  ]
}