---
title: "Get Portfolio Group Updates"
method: GET
path: "/portfolio/groups/{group_id}/updates"
tags: ["Portfolio Monitoring"]
---

# Get Portfolio Group Updates

`GET /portfolio/groups/{group_id}/updates`

## Path parameters

- `group_id` string, uuid, required

## Query parameters

- `q` string, nullable — The query param. Can be a business name, person name, business_id, person_id, or a type (business or person). If it is a business id or a person id (UUID), it will be used to search by id. If it is a business name or a person name, it will be used to search by name (case-insensitive). If it is a type (business or person), it will be used to search by type. If it is not provided, all portfolio updates will be returned.
- `attributes[]` NotifiableAttributes[], nullable — Filter by notification attributes
- `limit` integer — Maximum number of records to return in a single page. Must be between 1 and 1000.
- `offset` integer, nullable — Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor.
- `cursor` string, nullable — Opaque pagination cursor token that identifies the position in the result set. Use the cursor from the previous response to get the next page. Cannot be used with offset.
- `start_date` string, date, nullable — Filter records created on or after this date (format: YYYY-MM-DD).
- `end_date` string, date, nullable — Filter records created on or before this date (format: YYYY-MM-DD).
- `tz` string — IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).

## Response `200`

Response

- V1PortfolioItemUpdateResponse[]
  - `item` union, required — Portfolio item summary response - either Business or Person based on the item type. This is a discriminated union that selects the appropriate response type based on the `type` field.
    - V1BusinessPortfolioItemSummaryResponse — Represents a summary of a business portfolio item.
      - `id` string, uuid, required — The unique identifier of the portfolio item.
      - `search_id` string, uuid, required — The unique identifier of the search that the portfolio item is based on.
      - `name` string, required — The name of the portfolio item.
      - `group_id` string, uuid, nullable — The unique identifier of the portfolio group.
      - `user` V1UserAttributionResponse — Response model for user attribution operations. This model defines the structure for user attribution API responses.
        - `id` string, uuid, required — Unique identifier for the user.
        - `first_name` string, required — First name of the user.
        - `last_name` string, required — Last name of the user.
        - `email` string, required — Email address of the user.
      - `created_at` string, date-time, required — The timestamp of when the portfolio item was created.
      - `type` 'Business', required — The type of the portfolio item.
      - `business_id` string, uuid, required — The UUID of the business associated with the portfolio item.
      - `business_url` string, uri, required — The URL to the business details.
      - `item_url` string, required
      - `group_url` string, nullable, required
      - `console_url` string, required
    - V1PersonPortfolioItemSummaryResponse — Represents a summary of a person portfolio item.
      - `id` string, uuid, required — The unique identifier of the portfolio item.
      - `search_id` string, uuid, required — The unique identifier of the search that the portfolio item is based on.
      - `name` string, required — The name of the portfolio item.
      - `group_id` string, uuid, nullable — The unique identifier of the portfolio group.
      - `user` V1UserAttributionResponse — Response model for user attribution operations. This model defines the structure for user attribution API responses.
        - `id` string, uuid, required — Unique identifier for the user.
        - `first_name` string, required — First name of the user.
        - `last_name` string, required — Last name of the user.
        - `email` string, required — Email address of the user.
      - `created_at` string, date-time, required — The timestamp of when the portfolio item was created.
      - `type` 'Person', required — The type of the portfolio item.
      - `person_id` string, uuid, required — The UUID of the person associated with the portfolio item.
      - `person_url` string, uri, required — The URL to the person details.
      - `item_url` string, required
      - `group_url` string, nullable, required
      - `console_url` string, required
  - `from_snapshot_id` string, uuid, required — The unique identifier of the from snapshot.
  - `to_snapshot_id` string, uuid, required — The unique identifier of the to snapshot.
  - `change_count` integer, required — The number of changes in the portfolio item update.
  - `notification_count` integer, required — The number of notifications in the portfolio item update.
  - `notification_summaries` V1PortfolioItemNotificationSummary[], required — The notification summaries in the portfolio item update.
    - `attribute` 'registration_health' | 'new_registrations' | 'addresses' | 'officers' | 'alternative_names' | 'kyb_score' | 'risk_score' | 'identity_network' | 'pep' | 'ofac' | 'liens' | 'litigations' | 'bankruptcies' | 'website_analysis', required
    - `count` integer, required
  - `created_at` string, date-time, required — When the portfolio item update was created.
  - `item_url` string, required
  - `from_snapshot_url` string, required
  - `to_snapshot_url` string, required
  - `diff_url` string, required
  - `notifications_url` string, required
  - `notifications` V1PortfolioMonitoringNotificationResponse[], required — Generate notifications from the JSON patch data without expensive diffing. This uses the pre-computed json_patch data to create a PortfolioItemSnapshotDiff and then generates notifications from it, avoiding the expensive diff operation.
    - `message` V1StructuredText, required — This class represents a structured text in the application. StructuredText is used to annotate individual parts of the text with semantic types. This is helpful to the UI for stylized rendering. It provides a way to structure the text in a way that can be easily understood and manipulated by the UI.
      - `components` V1TextComponent[], required — The structured text annotates individual parts of the text with semantic types, which is helpful to the UI for stylized rendering.
        - `type` 'regular' | 'subject' | 'value' | 'label' | 'actor', required — SemanticType is an enumeration of the different types of semantic segments that a text can have. It is used to structure and annotate text in a way that can be helpful for stylized rendering in a UI, without forcing a particular style.
        - `text` string, required — This is the text part that composes the whole sentence within the StructuredText.
        - `for` string, nullable — The entity that the text describes. When present, it points to the entity that the text describes.
        - `url` string, uri, nullable — When present, it points to the entity that the text describes.
      - `text` string, required — The same content as found in the components, but without any styling.
    - `notifiable_attribute` 'registration_health' | 'new_registrations' | 'addresses' | 'officers' | 'alternative_names' | 'kyb_score' | 'risk_score' | 'identity_network' | 'pep' | 'ofac' | 'liens' | 'litigations' | 'bankruptcies' | 'website_analysis', required

## Other responses

- `422` — Validation Error

---

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