NetBird Read-Only MCP Preview
GET/api/groups

List groups

Lists groups, optionally filtered by an exact name match. Supply name to return groups with that exact name, or omit it to list groups without a name filter.

1 parameter
namestringoptional
Filter groups by exact name.

6 status codes
200Returns a JSON array of group objects, including each group's identifier, name, peer and resource counts, and associated peers and resources.
idstringrequired
Group ID
issuedstringoptional
How the group was issued (api, integration, jwt)
Allowed:apiintegrationjwt
namestringrequired
Group Name identifier
peers_countintegerrequired
Count of peers associated to the group
resources_countintegerrequired
Count of resources associated to the group
peersarray<object>required
List of peers object
resourcesarray<object>required
400Returned when the request is invalid.
401Returned when authentication is required but the request is unauthenticated.
403Returned when access to the requested groups is forbidden.
404Returned when the requested resource is not found.
500Returned when an internal server error occurs.

Error handling

A 400 is returned for a bad request; a 401 when authentication is required but not provided; a 403 when access is forbidden; a 404 when the requested resource is not found; and a 500 when an internal server error occurs. Use name for an exact group-name match.