Sign in

v51

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-01131107332.8 KB
Search
Groups

Search for groups

Returns a paginated list of all groups that match the provided filter criteria.

This operation can fail for the following reasons:

  • A server error occurred (HTTP error 500)
get/search/groups

Query parameters

offsetinteger

The number of artifacts to skip before starting to collect the result set. Defaults to 0.

limitinteger

The number of artifacts to return. Defaults to 20.

order'asc' | 'desc'

Sort order, ascending (asc) or descending (desc).

orderby'groupId' | 'createdOn' | 'modifiedOn'

The field to sort by. Can be one of:

  • name
  • createdOn
labelsstring[]

Filter by one or more name/value label. Separate each name/value pair using a colon. For example labels=foo:bar will return only artifacts with a label named foo and value bar.

descriptionstring

Filter by description.

groupIdstring

Filter by group name.

Response

On a successful response, returns a result set of groups - one for each group in the registry that matches the criteria.

countinteger required

The total number of groups that matched the query that produced the result set (may be more than the number of groups in the result set).

Example response

{
  "groups": [
    {
      "groupId": "My-Group",
      "name": "Group Name",
      "description": "Description of the group",
      "owner": "user1",
      "createdOn": "2019-03-22T12:51:19Z",
      "modifiedBy": "user1",
      "modifiedOn": "2019-03-22T12:51:19Z"
    }
  ]
}