Product objects

List business objects of a kind

Searches the full authorized set by external ID, declared column filters, agreement state and a declared date column. Returns a total and facets for the full filtered set. A cursor refuses changed filters or authority.

get/v1/products/{productId}/objects/{kind}

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/products/{productId}/objects/{kind}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

productIdstring required

Hyperscale product ID

kindstring required

Query parameters

ownerstring

Hyperscale principal ID

externalIdstring
agreementStatestring
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'
dueFieldstring
dueFromstring date-time
dueThroughstring date-time
cursorstring
limitinteger

Maximum items to return (1-100). Defaults to 50 when omitted.

Headers

X-Hyperscale-Environment'sandbox' | 'live'

Response

Success

nextCursorstring
totalinteger required
facetsobject required

Changes

No recorded changes to this operation across all 1 revision of this API.