> For the complete documentation index, see [llms.txt](https://docs.vcheckglobal.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vcheckglobal.com/api-reference/common-endpoints/groups.md).

# Groups

All groups on the account across all products.

## List All Groups

> Returns the list of all monitoring groups associated with the account. Each group includes the requestor, the count of active subjects being monitored, and the count of new (unreviewed) alerts.\
> \
> \*\*Pagination:\*\* Fixed 50 records per page. Pass \`?page=N\` to navigate. Stop when \`next\` is \`null\`.\
> \
> \### Response fields\
> \
> \| Field | Type | Description |\
> \|-------|------|-------------|\
> \| \`group\_id\` | integer | Unique group identifier |\
> \| \`name\` | string | Group name |\
> \| \`active\_subjects\` | integer | Count of distinct subjects with monitoring status 'On' |\
> \| \`created\_on\` | string (ISO 8601) | When the group was created |\
> \| \`new\_alerts\_count\` | integer | Count of non-archived alerts with status 'New' |\
> \| \`requestor\` | object / null | \`{name, email}\` of the user who created the group |<br>

```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Groups","description":"All groups on the account across all products."}],"servers":[{"url":"https://api-platform.vcheckglobal.net/v2","description":"Vcheck platform (sandbox host issued first; production host after sign-off)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Obtain a token via POST https://api-platform.vcheckglobal.net/v2/oauth2/token.\nInclude in all subsequent requests as `Authorization: Bearer <token>`.\nTokens expire after 3,600 seconds - cache and reuse; request a new one only when close to expiry.\n"}}},"paths":{"/groups":{"get":{"tags":["Groups"],"operationId":"getAllGroups","summary":"List All Groups","description":"Returns the list of all monitoring groups associated with the account. Each group includes the requestor, the count of active subjects being monitored, and the count of new (unreviewed) alerts.\n\n**Pagination:** Fixed 50 records per page. Pass `?page=N` to navigate. Stop when `next` is `null`.\n\n### Response fields\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `group_id` | integer | Unique group identifier |\n| `name` | string | Group name |\n| `active_subjects` | integer | Count of distinct subjects with monitoring status 'On' |\n| `created_on` | string (ISO 8601) | When the group was created |\n| `new_alerts_count` | integer | Count of non-archived alerts with status 'New' |\n| `requestor` | object / null | `{name, email}` of the user who created the group |\n","parameters":[{"name":"page","in":"query","required":false,"description":"Page number to retrieve (1-indexed, default: 1). Each page returns up to 50 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Groups retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"description":"Total number of records across all pages.","type":"integer"},"next":{"description":"Full URL to the next page. null on the last page.","type":["string","null"]},"previous":{"description":"Full URL to the previous page. null on the first page.","type":["string","null"]},"results":{"description":"Array of records for the current page (max 50).","type":"array","items":{"type":"object","properties":{"group_id":{"description":"Unique group identifier.","type":"integer"},"name":{"description":"Display name of the monitoring group.","type":"string"},"active_subjects":{"description":"Number of subjects actively being monitored in this group.","type":"integer"},"created_on":{"description":"Date and time the group was created (ISO 8601).","type":"string","format":"date-time"},"new_alerts_count":{"description":"Number of new (unreviewed) alerts in this group.","type":"integer"},"requestor":{"description":"The user who created this group. null if the user record has been removed.","type":["object","null"],"properties":{"name":{"description":"Full name of the requestor.","type":"string"},"email":{"description":"Email address of the requestor.","type":"string"}}}}}}}}}}},"403":{"description":"Forbidden - missing or invalid Client-ID credentials, insufficient scope, endpoint disabled via feature flag, or authenticated client has no linked account. Verify the scopes assigned to your credentials.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Authorization or access error message.","type":"string","default":"This endpoint is currently disabled."}}}}}},"500":{"description":"Internal server error - an unexpected error occurred. Please try again later or contact support if the issue persists.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Internal server error message.","type":"string","default":"An unexpected error occurred while processing the request."}}}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.vcheckglobal.com/api-reference/common-endpoints/groups.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.