Get Inventory Schema
Use this API to retrieve the schema (attribute definitions) for a specific inventory type. The schema defines all available attributes, their types, and validation rules for the specified inventory category.
This is useful for understanding the structure of inventory records before creating or updating them, or for dynamically building forms and validation logic.
Example Request
GET https://{hostname}/api/inventory/v2/schemas/{type}
GET https://trial.onetrust.com/api/inventory/v2/schemas/processing-activities
Path parameters
The type of inventory or schema to retrieve. Each type represents a different category of data mapping records:
- processing-activities: Records describing how personal data is processed
- vendors: Third-party organizations that process data on your behalf
- assets: Systems, applications, or databases that store or process data
- entities: Legal entities or business units within your organization
Query parameters
When set to true, returns the complete schema including all attribute details such as allowed values, validation rules, and metadata. When false or omitted, returns only basic attribute information.
Response
OK