List business objects of a kind
product.objects.list
Searches the full authorized set by external ID, declared column filters, agreement state and a declared date column. A signed-in customer's set is the records they own, the records where they are a party on an agreement, and the records with an entry action open for them; access on each item says which.
GET /v1/products/{productId}/objects/{kind}
Scopes: product:read
Input
| Field | Type | Description |
|---|---|---|
productId required | string | Hyperscale product ID |
kind required | string | |
owner | string | Hyperscale principal ID |
externalId | string | |
filters | object | Encode this string-valued filter object as JSON in the filters query parameter. |
agreementState | string | |
blockKey | financing.installments | escrow.hold | money.hold | marketplace.listing | marketplace.order | marketplace.reservation | insurance.cover | insurance.claim | |
blockMetric | overdue_installments | overdue_amount | held_funds | active_listings | awaiting_fulfilment | active_reservations | active_covers | submitted_claims | |
dueField | string | |
dueFrom | string | |
dueThrough | string | |
cursor | string | |
limit | integer | Maximum items to return (1-100). Defaults to 50 when omitted. |
Request sample
curl --request GET 'https://console.hyperscale0.ai/v1/products/{productId}/objects/{kind}' \
--header "Authorization: Bearer $HYPERSCALE_API_KEY" \
--header 'X-Hyperscale-Environment: sandbox'