EndpointsInventory structureInventory types
List configured inventory types
The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.
GET
Requires the read scope. Active definitions are returned in configured display order. Administrators may include archived definitions.
bearerAuthheader
AuthorizationBearer <inv_ token>includeArchived?booleanInclude archived definitions when authenticated as an administrator.
Default
falseX-Organization-ID?stringOrganization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.
Format
uuidInventory type definitions
application/json- response
types*array<>curl -X GET 'https://inventory.example.com/api/v1/inventory-types'Example Response
{ "types": [ { "key": "string", "label": "string", "description": "string", "color": "string", "icon": "string", "canContain": true, "spatialContainment": true, "position": 0, "isSystem": true, "createdBy": "string", "updatedBy": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "archivedAt": "2019-08-24T14:15:22Z" } ]}