Skip to main content
GET
Get Portfolio Item Snapshots

Authorizations

X-API-Key
string
header
required

Path Parameters

item_id
string<uuid>
required

The unique identifier of the portfolio item to fetch snapshots for.

Examples:

"412a49b5-7466-426b-bf1e-081b00b54576"

"9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5"

Query Parameters

limit
integer
default:10

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

Required range: 1 <= x <= 1000
offset
integer | null

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

Required range: x >= 0
cursor
string | null

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.

Response

Response

id
string<uuid>
required

The unique identifier of the snapshot.

portfolio_item_id
string<uuid>
required

The unique identifier of the portfolio item this snapshot belongs to.

schema_version
integer
required

The schema version of the snapshot data.

data
BusinessPortfolioItemSnapshotData (v1) · object
required

Represents the data of a business portfolio item snapshot.

created_at
string<date-time>
required

When the snapshot was created.

attributes
enum<string>[]

The attributes that were monitored when the snapshot was created.

The attributes that can be monitored.

Available options:
sos,
liens,
litigations,
bankruptcies,
website_analysis,
pep,
ofac,
identity_network