v1

latestOpenAPI 3.1.02026-07-241695611.0 MB

Portfolio Monitoring

Get Portfolio Updates

get/portfolio/updates

Query parameters

qstring 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

limitinteger

Maximum number of records to return in a single page. Must be between 1 and 1000.

offsetinteger nullable

Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor.

cursorstring 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_datestring date nullable

Filter records created on or after this date (format: YYYY-MM-DD).

end_datestring date nullable

Filter records created on or before this date (format: YYYY-MM-DD).

tzstring

IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).

Example:UTC

IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).

Response

from_snapshot_idstring uuid required

The unique identifier of the from snapshot.

to_snapshot_idstring uuid required

The unique identifier of the to snapshot.

change_countinteger required

The number of changes in the portfolio item update.

notification_countinteger required

The number of notifications in the portfolio item update.

created_atstring date-time required

When the portfolio item update was created.

item_urlstring required

from_snapshot_urlstring required

to_snapshot_urlstring required

diff_urlstring required

notifications_urlstring required

Example response

[
  {
    "item": {
      "search_id": "c623e29e-1f57-11ef-938f-1edb1b067314",
      "user": {
        "first_name": "Austin",
        "last_name": "Taylor",
        "email": "jessicasimpson@example.com"
      },
      "business_id": "ede786f3-33ae-4894-843d-af2025f1d5b0"
    }
  }
]