---
title: "List all groups"
method: GET
path: "/groups"
tags: ["Groups"]
---

# List all groups

`GET /groups`

List all groups

## Response `200`

Groups information

- object
  - `result` 'success' | 'error', required — Result of the request
  - `action` 'listGroups', required — The id of the action
  - `data` object, required
    - `groups` Group[], required
      - `id` string, uuid — Group id
      - `displayName` string — Name of the group
      - `description` string — Group description
      - `query` object — The criteria defining the group
        - `select` string — What kind of data we want to include. Here we can get policy servers/relay by setting `nodeAndPolicyServer`. Only used if `where` is defined.
        - `composition` 'and' | 'or' — Boolean operator to use between each `where` criteria.
        - `where` object[] — List of criteria
          - `objectType` string — Type of the object
          - `attribute` string — Attribute to compare
          - `comparator` string — Comparator to use
          - `value` string — Value to compare against
      - `nodeIds` string[] — List of nodes in the group
      - `dynamic` boolean — Should the group be dynamically refreshed (if not, it is a static group)
      - `enabled` boolean — Enable or disable the group
      - `groupClass` string[]
      - `properties` object[] — Group properties
        - `name` string, required — Property name
        - `value` string, string or JSON, required — Property value (can be a string or JSON object)

---

[API](https://skmtc.net/rudder/apis/rudder-api.md) · [All operations](https://skmtc.net/rudder/apis/rudder-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rudder/rudder-api/revisions/eab988254fba/schema)