> 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/monitoring/monitoring-groups.md).

# Monitoring Groups

Monitoring groups - list, inspect, and retrieve subjects and alerts within groups.

## List Monitoring Groups

> Returns the list of 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, user\_type}\` of the user who created the group |<br>

```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Monitoring Groups","description":"Monitoring groups - list, inspect, and retrieve subjects and alerts within groups."}],"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":{"/monitoring/groups":{"get":{"tags":["Monitoring Groups"],"operationId":"getMonitoringGroups","summary":"List Monitoring Groups","description":"Returns the list of 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, user_type}` 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":"Monitoring 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"},"user_type":{"description":"User type - Internal, External, or Email Only.","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."}}}}}}}}}}}
```

## Group Detail

> Returns detail for a single monitoring group including the requestor, project participants, and the count of active subjects.\
> \
> \### Response fields\
> \
> \| Field | Type | Description |\
> \|-------|------|-------------|\
> \| \`group\_id\` | integer | Unique group identifier |\
> \| \`name\` | string | Group name |\
> \| \`requestor\` | object / null | \`{name, email, user\_type}\` of the user who created the group |\
> \| \`project\_participants\` | array\[object] | List of \`{name, email, user\_type}\` participant entries |\
> \| \`active\_subjects\` | integer | Count of distinct subjects with monitoring status 'On' |\
> \| \`created\_on\` | string (ISO 8601) | When the group was created |<br>

```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Monitoring Groups","description":"Monitoring groups - list, inspect, and retrieve subjects and alerts within groups."}],"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":{"/monitoring/groups/{group_id}":{"get":{"tags":["Monitoring Groups"],"operationId":"getMonitoringGroupDetail","summary":"Group Detail","description":"Returns detail for a single monitoring group including the requestor, project participants, and the count of active subjects.\n\n### Response fields\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `group_id` | integer | Unique group identifier |\n| `name` | string | Group name |\n| `requestor` | object / null | `{name, email, user_type}` of the user who created the group |\n| `project_participants` | array[object] | List of `{name, email, user_type}` participant entries |\n| `active_subjects` | integer | Count of distinct subjects with monitoring status 'On' |\n| `created_on` | string (ISO 8601) | When the group was created |\n","parameters":[{"name":"group_id","in":"path","required":true,"description":"Unique monitoring group identifier.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Monitoring group detail retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"group_id":{"description":"Unique group identifier.","type":"integer"},"name":{"description":"Display name of the monitoring group.","type":"string"},"requestor":{"description":"The user who created this group.","type":["object","null"],"properties":{"name":{"description":"Full name of the requestor.","type":"string"},"email":{"description":"Email address of the requestor.","type":"string"},"user_type":{"description":"User type - Internal, External, or Email Only.","type":"string"}}},"project_participants":{"description":"List of participants assigned to this group.","type":"array","items":{"type":"object","properties":{"name":{"description":"Full name of the participant. null for email-only participants.","type":["string","null"]},"email":{"description":"Email address of the participant.","type":"string"},"user_type":{"description":"User type - Internal, External, or Email Only.","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"}}}}}},"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."}}}}}},"404":{"description":"Not found - group does not exist or does not belong to the authenticated account.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Resource not found message.","type":"string","default":"Group not found."}}}}}},"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."}}}}}}}}}}}
```

## List Subjects in Group

> Returns the list of subjects belonging to the specified monitoring group. Each subject includes their monitoring status within this group and whether they have open (New or In Review) alerts.\
> \
> \*\*Pagination:\*\* Fixed 50 records per page. Pass \`?page=N\` to navigate. Stop when \`next\` is \`null\`.\
> \
> \### Response fields\
> \
> \| Field | Type | Description |\
> \|-------|------|-------------|\
> \| \`subject\_id\` | integer | Unique subject identifier |\
> \| \`first\_name\` | string | Subject's first name |\
> \| \`middle\_name\` | string | Subject's middle name |\
> \| \`last\_name\_entity\` | string | Last name (Individual) or entity name (Entity) |\
> \| \`date\_of\_birth\` | string / null | Decrypted date of birth |\
> \| \`name\` | string | Full display name |\
> \| \`monitoring\_status\` | string | \`On\` or \`Off\` within this group |\
> \| \`open\_alerts\` | boolean | Whether the subject has open (New/In Review) alerts |\
> \| \`subject\_type\` | string | \`Individual\` or \`Entity\` |\
> \| \`has\_profile\_image\` | boolean | Whether the subject has a profile image |<br>

```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Monitoring Groups","description":"Monitoring groups - list, inspect, and retrieve subjects and alerts within groups."}],"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":{"/monitoring/groups/{group_id}/subjects":{"get":{"tags":["Monitoring Groups"],"operationId":"getMonitoringGroupSubjects","summary":"List Subjects in Group","description":"Returns the list of subjects belonging to the specified monitoring group. Each subject includes their monitoring status within this group and whether they have open (New or In Review) 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| `subject_id` | integer | Unique subject identifier |\n| `first_name` | string | Subject's first name |\n| `middle_name` | string | Subject's middle name |\n| `last_name_entity` | string | Last name (Individual) or entity name (Entity) |\n| `date_of_birth` | string / null | Decrypted date of birth |\n| `name` | string | Full display name |\n| `monitoring_status` | string | `On` or `Off` within this group |\n| `open_alerts` | boolean | Whether the subject has open (New/In Review) alerts |\n| `subject_type` | string | `Individual` or `Entity` |\n| `has_profile_image` | boolean | Whether the subject has a profile image |\n","parameters":[{"name":"group_id","in":"path","required":true,"description":"Unique monitoring group identifier.","schema":{"type":"integer"}},{"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":"Group subjects 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":{"subject_id":{"description":"Unique subject identifier.","type":"integer"},"first_name":{"description":"First name of the subject.","type":["string","null"]},"middle_name":{"description":"Middle name of the subject.","type":["string","null"]},"last_name_entity":{"description":"Last name for individuals, or entity name for organizations.","type":["string","null"]},"date_of_birth":{"description":"Date of birth of the subject. null if not provided.","type":["string","null"],"format":"date"},"name":{"description":"Computed full name of the subject.","type":"string"},"monitoring_status":{"description":"Current monitoring status within this group.","type":"string","enum":["On","Off"]},"open_alerts":{"description":"True if the subject has open (New or In Review) alerts in this group.","type":"boolean"},"subject_type":{"description":"Whether the subject is a person or an organization.","type":"string","enum":["Individual","Entity"]},"has_profile_image":{"description":"Whether the subject has a profile image uploaded.","type":"boolean"}}}}}}}}},"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."}}}}}},"404":{"description":"Not found - group does not exist or does not belong to the authenticated account.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Resource not found message.","type":"string","default":"Group not found."}}}}}},"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."}}}}}}}}}}}
```

## List Alerts in Group

> Returns the list of monitoring alerts for the specified group. Only active alerts (status IDs 1-4) are returned, excluding dismissed and resolved alerts.\
> \
> \*\*Pagination:\*\* Fixed 50 records per page. Pass \`?page=N\` to navigate. Stop when \`next\` is \`null\`.\
> \
> \### Response fields\
> \
> \| Field | Type | Description |\
> \|-------|------|-------------|\
> \| \`alert\_id\` | integer | Unique alert identifier |\
> \| \`subject\` | object / null | \`{id, name}\` of the subject |\
> \| \`group\` | string | Group name |\
> \| \`title\` | string / null | Alert title |\
> \| \`monitoring\_alert\_type\` | string | Alert type (e.g. \`PEP\`, \`Criminal\`, \`Adverse Media\`) |\
> \| \`alert\_date\` | string (ISO 8601) | When the alert was raised |\
> \| \`created\_on\` | string (ISO 8601) | Record creation timestamp |\
> \| \`monitoring\_alert\_status\` | string | Alert status (e.g. \`New\`, \`In Review\`) |\
> \| \`monitoring\_alert\_risk\` | string | Risk level (\`High\`, \`Medium\`, \`Low\`) |\
> \| \`subject\_type\` | string | \`Individual\` or \`Entity\` |\
> \| \`category\` | string / null | Alert category |\
> \| \`alert\_status\_risk\` | object | Combined \`{monitoring\_alert\_risk, monitoring\_alert\_status}\` |\
> \| \`is\_escalated\` | boolean | Whether the alert is escalated |<br>

```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Monitoring Groups","description":"Monitoring groups - list, inspect, and retrieve subjects and alerts within groups."}],"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":{"/monitoring/groups/{group_id}/alerts":{"get":{"tags":["Monitoring Groups"],"operationId":"getMonitoringGroupAlerts","summary":"List Alerts in Group","description":"Returns the list of monitoring alerts for the specified group. Only active alerts (status IDs 1-4) are returned, excluding dismissed and resolved 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| `alert_id` | integer | Unique alert identifier |\n| `subject` | object / null | `{id, name}` of the subject |\n| `group` | string | Group name |\n| `title` | string / null | Alert title |\n| `monitoring_alert_type` | string | Alert type (e.g. `PEP`, `Criminal`, `Adverse Media`) |\n| `alert_date` | string (ISO 8601) | When the alert was raised |\n| `created_on` | string (ISO 8601) | Record creation timestamp |\n| `monitoring_alert_status` | string | Alert status (e.g. `New`, `In Review`) |\n| `monitoring_alert_risk` | string | Risk level (`High`, `Medium`, `Low`) |\n| `subject_type` | string | `Individual` or `Entity` |\n| `category` | string / null | Alert category |\n| `alert_status_risk` | object | Combined `{monitoring_alert_risk, monitoring_alert_status}` |\n| `is_escalated` | boolean | Whether the alert is escalated |\n","parameters":[{"name":"group_id","in":"path","required":true,"description":"Unique monitoring group identifier.","schema":{"type":"integer"}},{"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":"Group alerts 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":{"alert_id":{"description":"Unique alert identifier.","type":"integer"},"subject":{"description":"The subject this alert is associated with.","type":["object","null"],"properties":{"id":{"description":"Subject identifier.","type":"integer"},"name":{"description":"Subject full name.","type":"string"}}},"group":{"description":"Name of the monitoring group.","type":"string"},"title":{"description":"Alert title. Currently null.","type":["string","null"]},"monitoring_alert_type":{"description":"Type of monitoring alert (e.g. 'PEP', 'Criminal', 'Adverse Media').","type":"string"},"alert_date":{"description":"Date and time the alert was triggered (ISO 8601).","type":"string","format":"date-time"},"created_on":{"description":"Date and time the alert record was created (ISO 8601).","type":"string","format":"date-time"},"monitoring_alert_status":{"description":"Current status of the alert (e.g. 'New', 'In Review', 'Resolved').","type":"string"},"agency":{"description":"Reporting agency name.","type":["string","null"]},"comments":{"description":"Alert comments.","type":["string","null"]},"updated_on":{"description":"Date and time the alert was last updated (ISO 8601).","type":"string","format":"date-time"},"monitoring_alert_risk":{"description":"Risk level of the alert (e.g. 'High', 'Medium', 'Low').","type":"string"},"subject_type":{"description":"Whether the subject is a person or an organization.","type":"string","enum":["Individual","Entity"]},"category":{"description":"Alert category (e.g. 'Department of Health and Human Services').","type":["string","null"]},"alert_status_risk":{"description":"Combined status and risk for the alert.","type":"object","properties":{"monitoring_alert_risk":{"description":"Risk level.","type":"string"},"monitoring_alert_status":{"description":"Status.","type":"string"}}},"is_escalated":{"description":"Whether the alert has been escalated.","type":"boolean"},"has_profile_image":{"description":"Whether the subject has a profile image uploaded.","type":"boolean"}}}}}}}}},"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."}}}}}},"404":{"description":"Not found - group does not exist or does not belong to the authenticated account.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Resource not found message.","type":"string","default":"Group not found."}}}}}},"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/monitoring/monitoring-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.