Hyperscale docs Sign in Start building

Read every agreement attached to an object

product.objects.agreements.list

Includes closed agreements and agreements without public actions, across retained Builds. Terms come from the agreement snapshot, state and declared relationships from its retained Build.

GET /v1/products/{productId}/objects/{kind}/{objectId}/agreements

Scopes: product:read

Input

FieldTypeDescription
productId requiredstringHyperscale product ID
kind requiredstring
objectId requiredstring
cursorstring
limitintegerMaximum items to return (1-100). Defaults to 50 when omitted.
rootsOnlytrue | false
parentInstanceIdstring

Request sample

curl --request GET 'https://console.hyperscale0.ai/v1/products/{productId}/objects/{kind}/{objectId}/agreements' \
  --header "Authorization: Bearer $HYPERSCALE_API_KEY" \
  --header 'X-Hyperscale-Environment: sandbox'

All operations