--- title: "Discover business object kinds, authored fields, and attached actions" method: GET path: "/v1/products/{productId}/objects" tags: ["Product objects"] --- # Discover business object kinds, authored fields, and attached actions `GET /v1/products/{productId}/objects` ## Request - Base URL: `https://hyperscale0.ai` - URL: `https://hyperscale0.ai/v1/products/{productId}/objects` - Auth: one of: - HTTP bearer - HTTP bearer Returns compiled object kinds with field definitions, authored fields, JSON Schema for creation, and available attached actions with requirement schemas. ## Path parameters - `productId` string, required: Hyperscale product ID ## Headers - `X-Hyperscale-Environment` 'sandbox' | 'live' ## Response `200` Success - ProductObjectsDiscoverOutput - `semantics` object, required - `currency` string, required - `parties` object, required - `objects` object[], required - `entryActions` string[] - `id` string, required - `title` string, required - `authoredFields` string[], required - `attachments` object[], required - `name` string, required - `title` string - `parent` string - `instrument` string, required - `parties` object, required - `cardinality` object, required - `min` integer, required - `max` integer, nullable, required - `fields` union[], required - union - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'money', required - `value` string - `minimum` string - `maximum` string - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'ref', required - `targetKind` 'instrument' | 'object', required - `targetFamily` union - … - `target` union, required - … - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'date', required - `value` string, date-time - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'duration', required - `value` integer - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'text', required - `value` string - `minLength` integer - `maxLength` integer - `pattern` string - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'integer', required - `value` integer - `minimum` integer - `maximum` integer - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'percent', required - `value` integer - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'boolean', required - `value` boolean - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'enum', required - `values` string[], required - `value` string - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'list', required - `item` 'money' | 'date' | 'text' | 'integer' | 'ref', required - `targetKind` 'instrument' | 'object' - `targetFamily` union - … - `target` string - `maxItems` integer, required - `columns` string[], required - `instruments` object[], required - `id` string, required - `title` string, required - `subject` string - `template` string - `fields` union[], required - union - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'money', required - `value` string - `minimum` string - `maximum` string - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'account', required - `owner` union, required - … - `key` string - `book` 'cash' | 'claim', required - `contra` true - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'ref', required - `targetKind` 'instrument' | 'object', required - `targetFamily` union - … - `target` union, required - … - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'date', required - `value` string, date-time - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'duration', required - `value` integer - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'text', required - `value` string - `minLength` integer - `maxLength` integer - `pattern` string - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'integer', required - `value` integer - `minimum` integer - `maximum` integer - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'percent', required - `value` integer - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'boolean', required - `value` boolean - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'enum', required - `values` string[], required - `value` string - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'list', required - `item` 'money' | 'date' | 'text' | 'integer' | 'ref', required - `targetKind` 'instrument' | 'object' - `targetFamily` union - … - `target` string - `maxItems` integer, required - `accounts` object[], required - `path` string, required - `scope` string, required - `instrument` string, required - `field` string, required - `owner` union, required - object - `kind` 'instrument', required - `instrument` string, required - object - `kind` 'role', required - `role` 'owner' | 'actor' | 'operator', required - object - `kind` 'party', required - `party` string, required - object - `kind` 'adapter', required - `adapter` string, required - `book` 'cash' | 'claim', required - `key` string - `contra` boolean, required - `relationships` object[], required - `kind` 'reference' | 'child', required - `via` 'field' | 'attachment' | 'invocation' | 'parent_actor', required - `name` string, required - `targetKind` 'instrument' | 'object', required - `targets` string[], required - `cardinality` object, required - `min` integer, required - `max` integer, nullable, required - `calculations` union[], required - union - object - `target` string, required - `op` 'at', required - `list` string, required - `position` union, required - … - object - `target` string, required - `op` 'aggregate', required - `selection` object, required - … - `measure` union, required - … - object - `target` string, required - `op` 'ratio', required - `amount` union, required - … - `numerator` union, required - … - `denominator` union, required - … - `rounding` 'floor', required - object - `target` string, required - `op` 'sum', required - `values` union[], required - … - object - `target` string, required - `op` 'subtract', required - `base` union, required - … - `subtract` union[], required - … - object - `target` string, required - `op` 'rate', required - `base` union, required - … - `bps` union, required - … - `rounding` 'floor', required - object - `target` string, required - `op` 'minimum', required - `values` union[], required - … - object - `target` string, required - `op` 'multiply', required - `amount` union, required - … - `units` union, required - … - object - `target` string, required - `op` 'divide', required - `amount` union, required - … - `divisor` union, required - … - `rounding` 'floor', required - object - `target` string, required - `op` 'annuity', required - `amount` union, required - … - `rate` union, required - … - `periods` union, required - … - `position` union, required - … - `part` 'principal' | 'interest', required - object - `target` string, required - `op` 'shift', required - `date` union, required - … - `milliseconds` union, required - … - `direction` 'before' | 'after', required - object - `target` string, required - `op` 'step', required - `date` union, required - … - `period` union, required - … - `times` union, required - … - `invariants` union[], required - union - object - `kind` 'hours', required - `at` string, required - `start` integer, required - `end` integer, required - `timezone` string, required - object - `kind` 'compare', required - `left` union, required - … - `operator` '==' | '!=' | '<' | '<=' | '>' | '>=', required - `right` union, required - … - object - `kind` 'state', required - `reference` string, required - `states` string[], required - object - `kind` 'unique', required - `namespace` string, required - `fields` string[], required - object - `kind` 'aggregate', required - `selection` object, required - … - `measure` union, required - … - `operator` '==' | '<=' | '>=' | '<' | '>', required - `value` union, required - … - object - `kind` 'evidence', required - `instruction` string - `subject` string, required - `family` string, required - `check` string, required - `result` string, required - `maxAge` integer, required - `initialState` string, required - `lifecycle` object, required - `initial` string, required - `states` object[], required - `name` string, required - `label` string, required - `terminal` boolean, required - `cancellationActions` string[], required - `actions` object[], required - `name` string, required - `alias` string, nullable, required - `title` string, required - `actor` union, required - 'caller' - 'clock' - object - `party` string, required - object - `parent` union, required - … - `roles` union[], required - union - object - … - object - … - object - … - object - … - object - … - object - … - `from` string[], required - `to` string, nullable, required - `references` union[] - union - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `invokedBy` object[] - `instrument` string, required - `action` string, required - `alias` string, nullable, required - `invocation` union, required - object - … - object - … - object - … - `inputs` union[], required - union - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `subject` object - `requirements` object[], required - `field` union, required - … - `objectField` string - `when` array[] - … - `adapters` object[], required - `binding` string, required - `snapshot` object, nullable, required - … - `renames` object - `prerequisites` union[], required - union - object - … - object - … - object - … - object - … - object - … - object - … - `due` object, nullable, required - `at` string, required - `offset` integer - `localDay` object - `days` integer, required - `direction` 'before' | 'after', required - `hour` integer, required - `timezone` string, required - `deadline` object, nullable, required - `at` string, required - `offset` integer - `localDay` object - `days` integer, required - `direction` 'before' | 'after', required - `hour` integer, required - `timezone` string, required - `calculations` union[], required - union - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `assignments` object, required - `moves` union[], required - union - object - … - object - … - object - … - object - … - `moneyEffects` object[], required - `key` string, required - `operation` 'internal_transfer.create' | 'internal_transfer.reserve' | 'internal_transfer.post' | 'internal_transfer.void', required - `amount` union, required - object - … - object - … - `from` object[], required - `path` string, required - `scope` string, required - `instrument` string, required - `field` string, required - `owner` union, required - … - `book` 'cash' | 'claim', required - `key` string - `contra` boolean, required - `to` object[], required - `path` string, required - `scope` string, required - `instrument` string, required - `field` string, required - `owner` union, required - … - `book` 'cash' | 'claim', required - `key` string - `contra` boolean, required - `disposition` 'held' | 'paid' | 'released' | 'claim' | 'unresolved', required - `transfer` string, nullable, required - `reservations` object[], required - `instrument` string, required - `action` string, required - `key` string, required - `economics` object, nullable, required - `purpose` 'earning' | 'principal' | 'participant_payout' | 'internal' | 'prepaid_credit' | 'pass_through', required - `sourceParty` string, required - `reversalOf` string, nullable, required - `share` object, nullable, required - `base` string, required - `bps` number, required - `value` string, nullable, required - `invokes` union[], required - union - object - … - object - … - object - … - `reports` object[], required - `identity` object, required - `id` string, required - `version` integer, required - `description` string, required - `scope` object, required - `kind` 'product' | 'company', required - `classification` 'internal' | 'personal' | 'restricted', required - `currency` 'SAR', required - `datasets` object[], required - `id` string, required - `source` 'instrument' | 'account' | 'identity' | 'operation', required - `instruments` string[], required - `rowKey` string, required - `columns` object[], required - `name` string, required - `field` string, required - `type` union, required - … - `required` boolean, required - `expressions` union[], required - union - … - `selection` string - `time` object, required - `timezone` 'Asia/Riyadh', required - `boundary` 'startInclusiveEndExclusive', required - `observation` 'periodEnd', required - `history` 'retainedOnly', required - `selection` object, required - `dataset` string, required - `predicate` string - `calculation` object, required - `joins` object[], required - `dataset` string, required - `local` string, required - `foreign` string, required - `cardinality` 'one' | 'many', required - `missing` 'refuse' | 'allow', required - `aggregates` object[], required - … - `expressions` union[], required - union - … - `groupBy` string[], required - `aggregates` object[], required - `name` string, required - `op` 'sum' | 'average' | 'count' | 'minimum' | 'maximum', required - `rounding` 'floor' | 'halfUp' - `value` string - `resultExpressions` union[], required - union - … - `validation` object, required - `empty` 'refuse' | 'noEligibleFacilities', required - `required` string[], required - `rowReconcile` object[], required - `left` string, required - `right` string, required - `reconcile` object[], required - `left` string, required - `right` string, required - `unavailableFacts` string[], required - `output` object, required - `profile` 'internal.v1', required - `formats` string[], required - `columns` object[], required - `name` string, required - `label` string, required - `type` union, required - … - `sort` string[], required - `authority` object, required - `request` string[], required - `read` string[], required - `release` string[], required - `retention` object, required - `policy` string, required - `years` integer, required - `structures` string[], required - `navigation` object[], required - `kind` string, required - `title` string, required - `creation` boolean, required - `productBuildId` string, required: Hyperscale product build ID - `digest` string, required - `kinds` object[], required - `attachments` object[], required - `name` string, required - `title` string, required - `instrument` string, required - `parentAttachment` string, nullable, required - `block` union, required - object - `key` string, required - `recordPath` string, required - `digest` string, required: Digest of the std declaration - object - `key` string, required - `recordPath` string, required - `headerDigest` string, required: SHA-256 digest of the resolved product build closure - `productBuildId` string, required: Hyperscale product build ID - `digest` string, required: SHA-256 digest of the resolved product build closure - `creation` true, required - `kind` string, required - `title` string, required - `fields` union[], required - union - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'money', required - `value` string - `minimum` string - `maximum` string - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'ref', required - `targetKind` 'instrument' | 'object', required - `targetFamily` union - object - … - object - … - `target` union, required - string - string[] - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'date', required - `value` string, date-time - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'duration', required - `value` integer - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'text', required - `value` string - `minLength` integer - `maxLength` integer - `pattern` string - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'integer', required - `value` integer - `minimum` integer - `maximum` integer - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'percent', required - `value` integer - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'boolean', required - `value` boolean - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'enum', required - `values` string[], required - `value` string - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'list', required - `item` 'money' | 'date' | 'text' | 'integer' | 'ref', required - `targetKind` 'instrument' | 'object' - `targetFamily` union - object - … - object - … - `target` string - `maxItems` integer, required - `authoredFields` string[], required - `columns` string[], required - `filters` object[], required - `field` string, required - `type` 'text' | 'enum' | 'date' | 'boolean' | 'integer', required - `createSchema` object, required - `actions` object[], required - `summary` string, required - `productBuildId` string, required: Hyperscale product build ID - `digest` string, required: SHA-256 digest of the resolved product build closure - `target` union, required - object - `kind` 'attachment', required - `attachment` string, required - object - `kind` 'instance', required - `attachment` string, required - `instanceId` string, required - `fieldsSchema` object, required - `name` string, required - `title` string, required - `instrument` string, required - `action` string, required - `requirements` union[], required - union - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'money', required - `value` string - `minimum` string - `maximum` string - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'ref', required - `targetKind` 'instrument' | 'object', required - `targetFamily` union - … - `target` union, required - … - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'date', required - `value` string, date-time - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'duration', required - `value` integer - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'text', required - `value` string - `minLength` integer - `maxLength` integer - `pattern` string - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'integer', required - `value` integer - `minimum` integer - `maximum` integer - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'percent', required - `value` integer - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'boolean', required - `value` boolean - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'enum', required - `values` string[], required - `value` string - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'list', required - `item` 'money' | 'date' | 'text' | 'integer' | 'ref', required - `targetKind` 'instrument' | 'object' - `targetFamily` union - … - `target` string - `maxItems` integer, required - `requirementConditions` object - `creationRequirements` union[] - union - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'money', required - `value` string - `minimum` string - `maximum` string - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'ref', required - `targetKind` 'instrument' | 'object', required - `targetFamily` union - … - `target` union, required - … - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'date', required - `value` string, date-time - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'duration', required - `value` integer - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'text', required - `value` string - `minLength` integer - `maxLength` integer - `pattern` string - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'integer', required - `value` integer - `minimum` integer - `maximum` integer - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'percent', required - `value` integer - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'boolean', required - `value` boolean - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'enum', required - `values` string[], required - `value` string - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'list', required - `item` 'money' | 'date' | 'text' | 'integer' | 'ref', required - `targetKind` 'instrument' | 'object' - `targetFamily` union - … - `target` string - `maxItems` integer, required - `creationOnlyNames` string[] - `inputSchema` object, required - `availability` union, required - object - `status` 'available', required - object - `status` 'requires_input', required - `subjectFields` string[], required - `actionInputs` string[], required - `parties` string[], required - `reason` string, required - object - `status` 'unavailable', required - `blockers` object[], required - `code` 'permission_required' | 'state_changed' | 'not_due' | 'deadline_passed' | 'clock_pending' | 'condition_not_met' | 'already_used' | 'evidence_required' | 'account_unavailable' | 'insufficient_balance' | 'setup_required' | 'invalid_input' | 'operation_pending', required - `reason` string, required - `recheckAt` string - `details` object: For insufficient_balance: the paying account and the amounts in minor units, as execute's refusal carries them. Fund the shortfall into accountId. - … - `belongsTo` object - … - object - `status` 'unknown', required - `reason` string, required - `retainedKinds` object[], required - `attachments` object[], required - `name` string, required - `title` string, required - `instrument` string, required - `parentAttachment` string, nullable, required - `block` union, required - object - `key` string, required - `recordPath` string, required - `digest` string, required: Digest of the std declaration - object - `key` string, required - `recordPath` string, required - `headerDigest` string, required: SHA-256 digest of the resolved product build closure - `kind` string, required - `title` string, required - `productBuildId` string, required: Hyperscale product build ID - `digest` string, required: SHA-256 digest of the resolved product build closure - `fields` union[], required - union - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'money', required - `value` string - `minimum` string - `maximum` string - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'ref', required - `targetKind` 'instrument' | 'object', required - `targetFamily` union - object - … - object - … - `target` union, required - string - string[] - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'date', required - `value` string, date-time - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'duration', required - `value` integer - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'text', required - `value` string - `minLength` integer - `maxLength` integer - `pattern` string - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'integer', required - `value` integer - `minimum` integer - `maximum` integer - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'percent', required - `value` integer - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'boolean', required - `value` boolean - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'enum', required - `values` string[], required - `value` string - object - `name` string, required - `label` string - `optional` true - `description` string - `sensitive` true - `type` 'list', required - `item` 'money' | 'date' | 'text' | 'integer' | 'ref', required - `targetKind` 'instrument' | 'object' - `targetFamily` union - object - … - object - … - `target` string - `maxItems` integer, required - `authoredFields` string[], required - `columns` string[], required - `filters` object[], required - `field` string, required - `type` 'text' | 'enum' | 'date' | 'boolean' | 'integer', required - `creation` false, required ## Other responses - `default`: ErrorResponse. See x-error-codes and x-errors for codes, HTTP statuses and retry guidance. --- [API](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api.md) · [All operations](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api/revisions/e9e8faa044d5?raw)