---
title: "Get Inventory by ID"
method: GET
path: "/api/inventory/v2/inventories/{schemaName}/{id}"
tags: ["Inventory"]
---

# Get Inventory by ID

`GET /api/inventory/v2/inventories/{schemaName}/{id}`

Use this API to retrieve the details of a specific inventory.

## Path parameters

- `schemaName` 'processing-activities' | 'vendors' | 'assets' | 'entities', required
- `id` string, uuid, required

## Response `200`

OK - Successfully retrieved inventory details.

- union
  - object
    - `data` VendorInventory
      - `id` string, uuid — Unique identifier of the inventory item
      - `organization` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `canViewDetails` boolean — Flag indicating if the current user can view inventory details
      - `name` string — Name of the inventory
      - `riskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Risk level of the inventory
      - `riskScore` number — Risk score of the inventory
      - `status` KeyNameDto
        - `key` string, required — The key identifier
        - `name` string — The display name associated with the key
      - `externalId` string — External identifier of the inventory
      - `createdDate` string, date-time — Date and time when the inventory was created
      - `createdBy` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `updatedDate` string, date-time — Date and time when the inventory was last updated
      - `updatedBy` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `selectFields` object — Map of select fields with their values
      - `textFields` object — Map of text fields with their values
      - `number` integer — Sequence number of the inventory
      - `isParent` boolean — Flag indicating if this inventory is a parent
      - `inheritFromMaster` boolean — Flag indicating if this inventory inherits from master
      - `parentInventoryId` string, uuid — ID of the parent inventory
      - `masterRecord` string — Reference to the master record
      - `workflow` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `workflowStage` InventoryWorkflowStageDto
        - `stage` ObjectReference
          - `id` string, uuid
          - `value` string
          - `valueKey` string
        - `badgeColor` string — Color code for the workflow stage badge
      - `inherentRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Inherent risk level of the inventory
      - `inherentRiskScore` number — Inherent risk score of the inventory
      - `targetRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Target risk level of the inventory
      - `targetRiskScore` number — Target risk score of the inventory
      - `totalHierarchyRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Total hierarchy risk level of the inventory
      - `totalHierarchyRiskScore` number — Total hierarchy risk score of the inventory
      - `totalHierarchyInherentRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Total hierarchy inherent risk level of the inventory
      - `totalHierarchyInherentRiskScore` number — Total hierarchy inherent risk score of the inventory
      - `totalHierarchyTargetRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Total hierarchy target risk level of the inventory
      - `totalHierarchyTargetRiskScore` number — Total hierarchy target risk score of the inventory
      - `inventoryDeleteType` 'HARD' | 'SOFT' | 'NONE' — Type of deletion for the inventory
      - `deletedReason` string — Reason for deletion of the inventory
      - `deletedBy` string, uuid — ID of the user who deleted the inventory
      - `deletedDate` string, date-time — Date and time when the inventory was deleted
      - `isGlobalAttributeConfigurationEnabled` boolean — Flag indicating if global attribute configuration is enabled
      - `sourceId` string, uuid — ID of the source inventory
      - `integrationWorkflowId` string — ID of the integration workflow
      - `sourceType` string — Type of the source inventory
      - `reviewType` string — Type of review for the inventory
      - `similarRecord` SimilarRecordDetail
        - `id` string, uuid
        - `name` string
        - `organization` ObjectReference
          - `id` string, uuid
          - `value` string
          - `valueKey` string
        - `location` ObjectReference
          - `id` string, uuid
          - `value` string
          - `valueKey` string
        - `hasAccessToSimilarRecord` boolean
      - `type` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `deletable` boolean
      - `editable` boolean
  - object
    - `data` AssetInventory
      - `id` string, uuid — Unique identifier of the inventory item
      - `organization` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `canViewDetails` boolean — Flag indicating if the current user can view inventory details
      - `name` string — Name of the inventory
      - `riskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Risk level of the inventory
      - `riskScore` number — Risk score of the inventory
      - `status` KeyNameDto
        - `key` string, required — The key identifier
        - `name` string — The display name associated with the key
      - `externalId` string — External identifier of the inventory
      - `createdDate` string, date-time — Date and time when the inventory was created
      - `createdBy` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `updatedDate` string, date-time — Date and time when the inventory was last updated
      - `updatedBy` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `selectFields` object — Map of select fields with their values
      - `textFields` object — Map of text fields with their values
      - `number` integer — Sequence number of the inventory
      - `isParent` boolean — Flag indicating if this inventory is a parent
      - `inheritFromMaster` boolean — Flag indicating if this inventory inherits from master
      - `parentInventoryId` string, uuid — ID of the parent inventory
      - `masterRecord` string — Reference to the master record
      - `workflow` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `workflowStage` InventoryWorkflowStageDto
        - `stage` ObjectReference
          - `id` string, uuid
          - `value` string
          - `valueKey` string
        - `badgeColor` string — Color code for the workflow stage badge
      - `inherentRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Inherent risk level of the inventory
      - `inherentRiskScore` number — Inherent risk score of the inventory
      - `targetRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Target risk level of the inventory
      - `targetRiskScore` number — Target risk score of the inventory
      - `totalHierarchyRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Total hierarchy risk level of the inventory
      - `totalHierarchyRiskScore` number — Total hierarchy risk score of the inventory
      - `totalHierarchyInherentRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Total hierarchy inherent risk level of the inventory
      - `totalHierarchyInherentRiskScore` number — Total hierarchy inherent risk score of the inventory
      - `totalHierarchyTargetRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Total hierarchy target risk level of the inventory
      - `totalHierarchyTargetRiskScore` number — Total hierarchy target risk score of the inventory
      - `inventoryDeleteType` 'HARD' | 'SOFT' | 'NONE' — Type of deletion for the inventory
      - `deletedReason` string — Reason for deletion of the inventory
      - `deletedBy` string, uuid — ID of the user who deleted the inventory
      - `deletedDate` string, date-time — Date and time when the inventory was deleted
      - `isGlobalAttributeConfigurationEnabled` boolean — Flag indicating if global attribute configuration is enabled
      - `sourceId` string, uuid — ID of the source inventory
      - `integrationWorkflowId` string — ID of the integration workflow
      - `sourceType` string — Type of the source inventory
      - `reviewType` string — Type of review for the inventory
      - `similarRecord` SimilarRecordDetail
        - `id` string, uuid
        - `name` string
        - `organization` ObjectReference
          - `id` string, uuid
          - `value` string
          - `valueKey` string
        - `location` ObjectReference
          - `id` string, uuid
          - `value` string
          - `valueKey` string
        - `hasAccessToSimilarRecord` boolean
      - `location` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `deletable` boolean
      - `editable` boolean
  - object
    - `data` EntityInventory
      - `id` string, uuid — Unique identifier of the inventory item
      - `organization` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `canViewDetails` boolean — Flag indicating if the current user can view inventory details
      - `name` string — Name of the inventory
      - `riskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Risk level of the inventory
      - `riskScore` number — Risk score of the inventory
      - `status` KeyNameDto
        - `key` string, required — The key identifier
        - `name` string — The display name associated with the key
      - `externalId` string — External identifier of the inventory
      - `createdDate` string, date-time — Date and time when the inventory was created
      - `createdBy` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `updatedDate` string, date-time — Date and time when the inventory was last updated
      - `updatedBy` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `selectFields` object — Map of select fields with their values
      - `textFields` object — Map of text fields with their values
      - `number` integer — Sequence number of the inventory
      - `isParent` boolean — Flag indicating if this inventory is a parent
      - `inheritFromMaster` boolean — Flag indicating if this inventory inherits from master
      - `parentInventoryId` string, uuid — ID of the parent inventory
      - `masterRecord` string — Reference to the master record
      - `workflow` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `workflowStage` InventoryWorkflowStageDto
        - `stage` ObjectReference
          - `id` string, uuid
          - `value` string
          - `valueKey` string
        - `badgeColor` string — Color code for the workflow stage badge
      - `inherentRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Inherent risk level of the inventory
      - `inherentRiskScore` number — Inherent risk score of the inventory
      - `targetRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Target risk level of the inventory
      - `targetRiskScore` number — Target risk score of the inventory
      - `totalHierarchyRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Total hierarchy risk level of the inventory
      - `totalHierarchyRiskScore` number — Total hierarchy risk score of the inventory
      - `totalHierarchyInherentRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Total hierarchy inherent risk level of the inventory
      - `totalHierarchyInherentRiskScore` number — Total hierarchy inherent risk score of the inventory
      - `totalHierarchyTargetRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Total hierarchy target risk level of the inventory
      - `totalHierarchyTargetRiskScore` number — Total hierarchy target risk score of the inventory
      - `inventoryDeleteType` 'HARD' | 'SOFT' | 'NONE' — Type of deletion for the inventory
      - `deletedReason` string — Reason for deletion of the inventory
      - `deletedBy` string, uuid — ID of the user who deleted the inventory
      - `deletedDate` string, date-time — Date and time when the inventory was deleted
      - `isGlobalAttributeConfigurationEnabled` boolean — Flag indicating if global attribute configuration is enabled
      - `sourceId` string, uuid — ID of the source inventory
      - `integrationWorkflowId` string — ID of the integration workflow
      - `sourceType` string — Type of the source inventory
      - `reviewType` string — Type of review for the inventory
      - `similarRecord` SimilarRecordDetail
        - `id` string, uuid
        - `name` string
        - `organization` ObjectReference
          - `id` string, uuid
          - `value` string
          - `valueKey` string
        - `location` ObjectReference
          - `id` string, uuid
          - `value` string
          - `valueKey` string
        - `hasAccessToSimilarRecord` boolean
      - `primaryOperatingLocation` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `deletable` boolean
      - `editable` boolean
  - object
    - `data` Inventory
      - `id` string, uuid — Unique identifier of the inventory item
      - `organization` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `canViewDetails` boolean — Flag indicating if the current user can view inventory details
      - `name` string — Name of the inventory
      - `riskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Risk level of the inventory
      - `riskScore` number — Risk score of the inventory
      - `status` KeyNameDto
        - `key` string, required — The key identifier
        - `name` string — The display name associated with the key
      - `externalId` string — External identifier of the inventory
      - `createdDate` string, date-time — Date and time when the inventory was created
      - `createdBy` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `updatedDate` string, date-time — Date and time when the inventory was last updated
      - `updatedBy` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `selectFields` object — Map of select fields with their values
      - `textFields` object — Map of text fields with their values
      - `number` integer — Sequence number of the inventory
      - `isParent` boolean — Flag indicating if this inventory is a parent
      - `inheritFromMaster` boolean — Flag indicating if this inventory inherits from master
      - `parentInventoryId` string, uuid — ID of the parent inventory
      - `masterRecord` string — Reference to the master record
      - `workflow` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `workflowStage` InventoryWorkflowStageDto
        - `stage` ObjectReference
          - `id` string, uuid
          - `value` string
          - `valueKey` string
        - `badgeColor` string — Color code for the workflow stage badge
      - `inherentRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Inherent risk level of the inventory
      - `inherentRiskScore` number — Inherent risk score of the inventory
      - `targetRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Target risk level of the inventory
      - `targetRiskScore` number — Target risk score of the inventory
      - `totalHierarchyRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Total hierarchy risk level of the inventory
      - `totalHierarchyRiskScore` number — Total hierarchy risk score of the inventory
      - `totalHierarchyInherentRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Total hierarchy inherent risk level of the inventory
      - `totalHierarchyInherentRiskScore` number — Total hierarchy inherent risk score of the inventory
      - `totalHierarchyTargetRiskLevel` 'ZERO' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' — Total hierarchy target risk level of the inventory
      - `totalHierarchyTargetRiskScore` number — Total hierarchy target risk score of the inventory
      - `inventoryDeleteType` 'HARD' | 'SOFT' | 'NONE' — Type of deletion for the inventory
      - `deletedReason` string — Reason for deletion of the inventory
      - `deletedBy` string, uuid — ID of the user who deleted the inventory
      - `deletedDate` string, date-time — Date and time when the inventory was deleted
      - `isGlobalAttributeConfigurationEnabled` boolean — Flag indicating if global attribute configuration is enabled
      - `sourceId` string, uuid — ID of the source inventory
      - `integrationWorkflowId` string — ID of the integration workflow
      - `sourceType` string — Type of the source inventory
      - `reviewType` string — Type of review for the inventory
      - `similarRecord` SimilarRecordDetail
        - `id` string, uuid
        - `name` string
        - `organization` ObjectReference
          - `id` string, uuid
          - `value` string
          - `valueKey` string
        - `location` ObjectReference
          - `id` string, uuid
          - `value` string
          - `valueKey` string
        - `hasAccessToSimilarRecord` boolean
      - `deletable` boolean
      - `editable` boolean

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `429` — Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500` — Internal Server Error

---

[API](https://skmtc.net/onetrust/apis/platform-access-management.md) · [All operations](https://skmtc.net/onetrust/apis/platform-access-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onetrust/platform-access-management/versions/21de3aa0b170/schema)
