---
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}`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/inventory/v2/inventories/{schemaName}/{id}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `INVENTORY`, `INVENTORY_READ`, `INVENTORY_WRITE`

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
      - `detailsUri` string: URI for viewing the inventory details page
      - `redacted` string[]: Field names that should be redacted when user lacks advanced view access
      - `type` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `editable` boolean
      - `deletable` 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
      - `detailsUri` string: URI for viewing the inventory details page
      - `redacted` string[]: Field names that should be redacted when user lacks advanced view access
      - `location` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `editable` boolean
      - `deletable` 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
      - `detailsUri` string: URI for viewing the inventory details page
      - `redacted` string[]: Field names that should be redacted when user lacks advanced view access
      - `primaryOperatingLocation` ObjectReference
        - `id` string, uuid
        - `value` string
        - `valueKey` string
      - `editable` boolean
      - `deletable` 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
      - `detailsUri` string: URI for viewing the inventory details page
      - `redacted` string[]: Field names that should be redacted when user lacks advanced view access
      - `editable` boolean
      - `deletable` 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.dev/onetrust/apis/privacy-automation-data-mapping-automation.md) - [All operations](https://skmtc.dev/onetrust/apis/privacy-automation-data-mapping-automation/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/privacy-automation-data-mapping-automation/revisions/daead5d9fad6?raw)