---
updatedAt: 2026-05-12T09:59:50.000Z
---

# Retrieve group collection for a client

This operation returns an object containing information about all Sentinel groups for the specified client ID.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Group API v2 (Legacy)",
    "license": {
      "name": "(c) Copyright 2020 WhiteHat Security"
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com"
    }
  ],
  "paths": {
    "/api/v2/group/{client_id}": {
      "get": {
        "tags": [
          "Group API v1.0"
        ],
        "summary": "Retrieve group collection for a client",
        "operationId": "getGroupCollectionForClient",
        "description": "This operation returns an object containing information about all Sentinel groups for the specified client ID.",
        "parameters": [
          {
            "name": "client_id",
            "in": "path",
            "description": "Client ID.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "query_tags",
            "in": "query",
            "description": "Retrieves groups that have one or more tags as specified by a comma-separated list.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query_notags",
            "in": "query",
            "description": "Retrieves groups that do NOT have one or more tags as specified by a comma-separated list.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query_contains_site",
            "in": "query",
            "description": "Retrieves groups containing sites with labels that begin with or match the given string. Case insensitive.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query_contains_app",
            "in": "query",
            "description": "Retrieves groups containing app with labels that begin with or match the given string. Case insensitive.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query_contains_asset",
            "in": "query",
            "description": "Retrieves groups containing asset with labels that begin with or match the given string. Case insensitive.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query_contains_user",
            "in": "query",
            "description": "Retrieves groups containing user with labels that begin with or match the given string. Case insensitive.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query_name_like",
            "in": "query",
            "description": "Retrieves groups with names matching or containing the given string.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "display_sites",
            "in": "query",
            "description": "Display sites associated with group id.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "0",
              "example": "0",
              "enum": [
                "0",
                "1"
              ]
            }
          },
          {
            "name": "display_applications",
            "in": "query",
            "description": "Display applications associated with group id.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "0",
              "example": "0",
              "enum": [
                "0",
                "1"
              ]
            }
          },
          {
            "name": "display_roles",
            "in": "query",
            "description": "Display roles associated with group id.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "0",
              "example": "0",
              "enum": [
                "0",
                "1"
              ]
            }
          },
          {
            "name": "display_vuln_stats",
            "in": "query",
            "description": "Display statistics for vulnerabilities found on assets in each group.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "0",
              "example": "0",
              "enum": [
                "0",
                "1"
              ]
            }
          },
          {
            "name": "display_scan_status",
            "in": "query",
            "description": "Displays a list of the scan statuses for the assets in each group.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "0",
              "example": "0",
              "enum": [
                "0",
                "1"
              ]
            }
          },
          {
            "name": "display_has_asset",
            "in": "query",
            "description": "Display the 'has_assets' flag, which indicates if each group contains any assets.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "0",
              "example": "0",
              "enum": [
                "0",
                "1"
              ]
            }
          },
          {
            "name": "page:limit",
            "in": "query",
            "description": "Number of pages to retrieve.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "page:offset",
            "in": "query",
            "description": "Begin retrieving pages from this index.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "page:order_by",
            "in": "query",
            "description": "Order results in ascending or descending order by name, id, or description.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "name",
              "example": "name",
              "enum": [
                "name",
                "name_asc",
                "name_desc",
                "id",
                "id_asc",
                "id_desc",
                "description",
                "description_asc",
                "description_desc"
              ]
            }
          },
          {
            "name": "format",
            "in": "query",
            "description": "Selects the requested response representation format.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "xml",
              "example": "json",
              "enum": [
                "json",
                "xml"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Provides the information of Sentinel groups for the specified client ID.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GroupV2Collection"
                }
              },
              "application/xml": {
                "example": "XML preview is currently not supported."
              }
            }
          },
          "400": {
            "description": "BadRequestResponse indicates a request with invalid parameters.",
            "content": {}
          },
          "401": {
            "description": "UnauthorizedResponse signals an unauthorized API access.",
            "content": {}
          },
          "403": {
            "description": "ForbiddenResponse signals a request for a resource that does not exist or is not authorized.",
            "content": {}
          },
          "500": {
            "description": "GenericError generic error.",
            "content": {}
          }
        },
        "deprecated": false
      }
    }
  },
  "components": {
    "schemas": {
      "GroupV2Page": {
        "properties": {
          "total": {
            "type": "number"
          },
          "offset": {
            "type": "number",
            "nullable": true
          },
          "limit": {
            "type": "number",
            "nullable": true
          },
          "order_by": {
            "type": "string"
          }
        }
      },
      "GroupV2Score": {
        "properties": {
          "medium": {
            "type": "string"
          },
          "critical": {
            "type": "string"
          },
          "high": {
            "type": "string"
          }
        }
      },
      "GroupV2Severity": {
        "properties": {
          "high": {
            "type": "string"
          },
          "critical": {
            "type": "string"
          },
          "low": {
            "type": "string"
          },
          "medium": {
            "type": "string"
          },
          "urgent": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "GroupV2Advanced": {
        "properties": {
          "impact": {
            "properties": {
              "low": {
                "type": "string"
              },
              "high": {
                "type": "string"
              },
              "medium": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "customized": {
            "type": "string"
          },
          "likelihood": {
            "properties": {
              "high": {
                "type": "string"
              },
              "low": {
                "type": "string"
              },
              "medium": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "risk": {
            "properties": {
              "critical": {
                "type": "string"
              },
              "high": {
                "type": "string"
              },
              "low": {
                "type": "string"
              },
              "note": {
                "type": "string"
              },
              "medium": {
                "type": "string"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      },
      "GroupV2VulnStats": {
        "properties": {
          "score": {
            "$ref": "#/components/schemas/GroupV2Score"
          },
          "accepted": {
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "string"
              }
            ]
          },
          "sites": {
            "properties": {
              "open": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "applications": {
            "properties": {
              "open": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "open": {
            "type": "number"
          },
          "severity": {
            "$ref": "#/components/schemas/GroupV2Severity"
          },
          "out_of_scope": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "number"
              }
            ]
          },
          "closed": {
            "type": "number"
          },
          "advanced": {
            "$ref": "#/components/schemas/GroupV2Advanced"
          }
        },
        "type": "object"
      },
      "GroupV2Role": {
        "properties": {
          "role": {
            "type": "string"
          },
          "id": {
            "type": "number"
          },
          "client_id": {
            "type": "number"
          },
          "username": {
            "type": "string"
          },
          "href": {
            "type": "string"
          }
        }
      },
      "GroupV2RoleCollection": {
        "properties": {
          "type": {
            "type": "string"
          },
          "collection": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GroupV2Role"
            }
          },
          "page": {
            "properties": {
              "total": {
                "type": "number"
              }
            },
            "type": "object"
          },
          "href": {
            "type": "string"
          }
        }
      },
      "GroupV2Site": {
        "properties": {
          "href": {
            "type": "string"
          },
          "id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "client_id": {
            "type": "number"
          },
          "url": {
            "type": "string"
          },
          "wsi_score": {
            "type": "number",
            "nullable": true
          },
          "global_rank": {
            "type": "number",
            "nullable": true
          },
          "industry_rank": {
            "type": "number",
            "nullable": true
          }
        }
      },
      "GroupV2SiteCollection": {
        "properties": {
          "href": {
            "type": "string"
          },
          "page": {
            "properties": {
              "total": {
                "type": "number"
              }
            },
            "type": "object"
          },
          "collection": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GroupV2Site"
            }
          },
          "type": {
            "type": "string"
          }
        }
      },
      "GroupV2Obj": {
        "properties": {
          "organization": {
            "type": "string"
          },
          "created": {
            "type": "string"
          },
          "vuln_stats": {
            "$ref": "#/components/schemas/GroupV2VulnStats"
          },
          "asset_stats": {
            "properties": {
              "application_count": {
                "type": "number"
              },
              "site_count": {
                "type": "number"
              }
            },
            "type": "object"
          },
          "sites": {
            "$ref": "#/components/schemas/GroupV2SiteCollection"
          },
          "created_by": {
            "type": "string",
            "nullable": true
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "has_asset": {
            "type": "number"
          },
          "scan_status": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "applications": {
            "$ref": "#/components/schemas/GroupV2AppCollection"
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "roles": {
            "$ref": "#/components/schemas/GroupV2RoleCollection"
          },
          "client_id": {
            "type": "number"
          },
          "href": {
            "type": "string"
          },
          "id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          }
        }
      },
      "GroupV2Collection": {
        "properties": {
          "href": {
            "type": "string"
          },
          "page": {
            "$ref": "#/components/schemas/GroupV2Page"
          },
          "collection": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GroupV2Obj"
            }
          },
          "type": {
            "type": "string"
          }
        }
      },
      "GroupV2App": {
        "properties": {
          "client_id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "id": {
            "type": "number"
          },
          "href": {
            "type": "string"
          }
        }
      },
      "GroupV2AppCollection": {
        "nullable": true,
        "properties": {
          "href": {
            "type": "string"
          },
          "page": {
            "properties": {
              "total": {
                "type": "number"
              }
            },
            "type": "object"
          },
          "collection": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GroupV2App"
            }
          },
          "type": {
            "type": "string"
          }
        }
      }
    }
  },
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  }
}
```