GET api/Inventories?filter={filter}&offset={offset}&max={max}
Fetch a list of inventories with optional filtering and offset
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| filter |
Json representation of InventoryFilter (optional) |
string |
None. |
| offset |
Starting offset of the items to return (optional) |
integer |
Default value is 0 |
| max |
Maximum number of items to return (optional) |
integer |
Default value is 100 |
Body Parameters
None.
Response Information
Resource Description
List of matching inventories
ListResultOfInventory| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalCount | integer |
None. |
|
| Items | Collection of Inventory |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalCount": 1,
"Items": [
{
"Serial": "sample string 1",
"Nr": "sample string 2",
"ManufacturerId": 3,
"InventoryModelId": 4,
"InventoryLocationId": 5,
"OrgUnitId": 6,
"InventoryTypeId": 7,
"ResponsibleUserId": 8,
"CurrentUserId": 9,
"WarrantyStartDate": "2025-12-08T14:26:38.0241102+00:00",
"WarrantyEndDate": "2025-12-08T14:26:38.0241102+00:00",
"InvoiceDate": "2025-12-08T14:26:38.0241102+00:00",
"Reference": "sample string 13",
"InventoryNumber": "sample string 14",
"InitialValue": 15.1,
"Note": "sample string 16",
"InventorySupplierId": 17,
"InventoryStateId": 18,
"InventoryConditionId": 19,
"InventoryCategoryId": 20,
"Comments": [
{
"UserId": 1,
"Text": "sample string 2",
"Date": "2025-12-08T14:26:38.0241102+00:00",
"Id": 4
},
{
"UserId": 1,
"Text": "sample string 2",
"Date": "2025-12-08T14:26:38.0241102+00:00",
"Id": 4
}
],
"RelatedContractIds": [
{
"External": true,
"Id": 2
},
{
"External": true,
"Id": 2
}
],
"RelatedInventoryIds": [
{
"External": true,
"Id": 2
},
{
"External": true,
"Id": 2
}
],
"Notifications": [
{
"Name": "sample string 1",
"ReminderCount": 2,
"EscalationCount": 3,
"Active": true,
"CommentText": "sample string 5",
"StartDate": "2025-12-08T14:26:38.0241102+00:00",
"EndDate": "2025-12-08T14:26:38.0241102+00:00",
"Confirmed": "2025-12-08T14:26:38.0241102+00:00",
"Type": "sample string 9",
"ConfirmedByUserId": 10,
"Message": "sample string 11",
"RecipientUserIds": [
1,
2
],
"Id": 12
},
{
"Name": "sample string 1",
"ReminderCount": 2,
"EscalationCount": 3,
"Active": true,
"CommentText": "sample string 5",
"StartDate": "2025-12-08T14:26:38.0241102+00:00",
"EndDate": "2025-12-08T14:26:38.0241102+00:00",
"Confirmed": "2025-12-08T14:26:38.0241102+00:00",
"Type": "sample string 9",
"ConfirmedByUserId": 10,
"Message": "sample string 11",
"RecipientUserIds": [
1,
2
],
"Id": 12
}
],
"TagIds": [
1,
2
],
"CompanyId": 21,
"Name": "sample string 22",
"LastModified": "2025-12-08T14:26:38.0241102+00:00",
"Created": "2025-12-08T14:26:38.0241102+00:00",
"Id": 25
},
{
"Serial": "sample string 1",
"Nr": "sample string 2",
"ManufacturerId": 3,
"InventoryModelId": 4,
"InventoryLocationId": 5,
"OrgUnitId": 6,
"InventoryTypeId": 7,
"ResponsibleUserId": 8,
"CurrentUserId": 9,
"WarrantyStartDate": "2025-12-08T14:26:38.0241102+00:00",
"WarrantyEndDate": "2025-12-08T14:26:38.0241102+00:00",
"InvoiceDate": "2025-12-08T14:26:38.0241102+00:00",
"Reference": "sample string 13",
"InventoryNumber": "sample string 14",
"InitialValue": 15.1,
"Note": "sample string 16",
"InventorySupplierId": 17,
"InventoryStateId": 18,
"InventoryConditionId": 19,
"InventoryCategoryId": 20,
"Comments": [
{
"UserId": 1,
"Text": "sample string 2",
"Date": "2025-12-08T14:26:38.0241102+00:00",
"Id": 4
},
{
"UserId": 1,
"Text": "sample string 2",
"Date": "2025-12-08T14:26:38.0241102+00:00",
"Id": 4
}
],
"RelatedContractIds": [
{
"External": true,
"Id": 2
},
{
"External": true,
"Id": 2
}
],
"RelatedInventoryIds": [
{
"External": true,
"Id": 2
},
{
"External": true,
"Id": 2
}
],
"Notifications": [
{
"Name": "sample string 1",
"ReminderCount": 2,
"EscalationCount": 3,
"Active": true,
"CommentText": "sample string 5",
"StartDate": "2025-12-08T14:26:38.0241102+00:00",
"EndDate": "2025-12-08T14:26:38.0241102+00:00",
"Confirmed": "2025-12-08T14:26:38.0241102+00:00",
"Type": "sample string 9",
"ConfirmedByUserId": 10,
"Message": "sample string 11",
"RecipientUserIds": [
1,
2
],
"Id": 12
},
{
"Name": "sample string 1",
"ReminderCount": 2,
"EscalationCount": 3,
"Active": true,
"CommentText": "sample string 5",
"StartDate": "2025-12-08T14:26:38.0241102+00:00",
"EndDate": "2025-12-08T14:26:38.0241102+00:00",
"Confirmed": "2025-12-08T14:26:38.0241102+00:00",
"Type": "sample string 9",
"ConfirmedByUserId": 10,
"Message": "sample string 11",
"RecipientUserIds": [
1,
2
],
"Id": 12
}
],
"TagIds": [
1,
2
],
"CompanyId": 21,
"Name": "sample string 22",
"LastModified": "2025-12-08T14:26:38.0241102+00:00",
"Created": "2025-12-08T14:26:38.0241102+00:00",
"Id": 25
}
]
}
application/xml, text/xml
Sample:
<ListResultOfInventoryHWVxl9UY xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ControlKeeper.ApiModel">
<Items>
<Inventory>
<Id>25</Id>
<Created>2025-12-08T14:26:38.0241102+00:00</Created>
<LastModified>2025-12-08T14:26:38.0241102+00:00</LastModified>
<Name>sample string 22</Name>
<CompanyId>21</CompanyId>
<Comments>
<Comment>
<Id>4</Id>
<Date>2025-12-08T14:26:38.0241102+00:00</Date>
<Text>sample string 2</Text>
<UserId>1</UserId>
</Comment>
<Comment>
<Id>4</Id>
<Date>2025-12-08T14:26:38.0241102+00:00</Date>
<Text>sample string 2</Text>
<UserId>1</UserId>
</Comment>
</Comments>
<CurrentUserId>9</CurrentUserId>
<InitialValue>15.1</InitialValue>
<InventoryCategoryId>20</InventoryCategoryId>
<InventoryConditionId>19</InventoryConditionId>
<InventoryLocationId>5</InventoryLocationId>
<InventoryModelId>4</InventoryModelId>
<InventoryNumber>sample string 14</InventoryNumber>
<InventoryStateId>18</InventoryStateId>
<InventorySupplierId>17</InventorySupplierId>
<InventoryTypeId>7</InventoryTypeId>
<InvoiceDate>2025-12-08T14:26:38.0241102+00:00</InvoiceDate>
<ManufacturerId>3</ManufacturerId>
<Note>sample string 16</Note>
<Notifications>
<Notification>
<Id>12</Id>
<Active>true</Active>
<CommentText>sample string 5</CommentText>
<Confirmed>2025-12-08T14:26:38.0241102+00:00</Confirmed>
<ConfirmedByUserId>10</ConfirmedByUserId>
<EndDate>2025-12-08T14:26:38.0241102+00:00</EndDate>
<EscalationCount>3</EscalationCount>
<Message>sample string 11</Message>
<Name>sample string 1</Name>
<RecipientUserIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:int>1</d6p1:int>
<d6p1:int>2</d6p1:int>
</RecipientUserIds>
<ReminderCount>2</ReminderCount>
<StartDate>2025-12-08T14:26:38.0241102+00:00</StartDate>
<Type>sample string 9</Type>
</Notification>
<Notification>
<Id>12</Id>
<Active>true</Active>
<CommentText>sample string 5</CommentText>
<Confirmed>2025-12-08T14:26:38.0241102+00:00</Confirmed>
<ConfirmedByUserId>10</ConfirmedByUserId>
<EndDate>2025-12-08T14:26:38.0241102+00:00</EndDate>
<EscalationCount>3</EscalationCount>
<Message>sample string 11</Message>
<Name>sample string 1</Name>
<RecipientUserIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:int>1</d6p1:int>
<d6p1:int>2</d6p1:int>
</RecipientUserIds>
<ReminderCount>2</ReminderCount>
<StartDate>2025-12-08T14:26:38.0241102+00:00</StartDate>
<Type>sample string 9</Type>
</Notification>
</Notifications>
<Nr>sample string 2</Nr>
<OrgUnitId>6</OrgUnitId>
<Reference>sample string 13</Reference>
<RelatedContractIds>
<RelatedIdentity>
<Id>2</Id>
<External>true</External>
</RelatedIdentity>
<RelatedIdentity>
<Id>2</Id>
<External>true</External>
</RelatedIdentity>
</RelatedContractIds>
<RelatedInventoryIds>
<RelatedIdentity>
<Id>2</Id>
<External>true</External>
</RelatedIdentity>
<RelatedIdentity>
<Id>2</Id>
<External>true</External>
</RelatedIdentity>
</RelatedInventoryIds>
<ResponsibleUserId>8</ResponsibleUserId>
<Serial>sample string 1</Serial>
<TagIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>1</d4p1:int>
<d4p1:int>2</d4p1:int>
</TagIds>
<WarrantyEndDate>2025-12-08T14:26:38.0241102+00:00</WarrantyEndDate>
<WarrantyStartDate>2025-12-08T14:26:38.0241102+00:00</WarrantyStartDate>
</Inventory>
<Inventory>
<Id>25</Id>
<Created>2025-12-08T14:26:38.0241102+00:00</Created>
<LastModified>2025-12-08T14:26:38.0241102+00:00</LastModified>
<Name>sample string 22</Name>
<CompanyId>21</CompanyId>
<Comments>
<Comment>
<Id>4</Id>
<Date>2025-12-08T14:26:38.0241102+00:00</Date>
<Text>sample string 2</Text>
<UserId>1</UserId>
</Comment>
<Comment>
<Id>4</Id>
<Date>2025-12-08T14:26:38.0241102+00:00</Date>
<Text>sample string 2</Text>
<UserId>1</UserId>
</Comment>
</Comments>
<CurrentUserId>9</CurrentUserId>
<InitialValue>15.1</InitialValue>
<InventoryCategoryId>20</InventoryCategoryId>
<InventoryConditionId>19</InventoryConditionId>
<InventoryLocationId>5</InventoryLocationId>
<InventoryModelId>4</InventoryModelId>
<InventoryNumber>sample string 14</InventoryNumber>
<InventoryStateId>18</InventoryStateId>
<InventorySupplierId>17</InventorySupplierId>
<InventoryTypeId>7</InventoryTypeId>
<InvoiceDate>2025-12-08T14:26:38.0241102+00:00</InvoiceDate>
<ManufacturerId>3</ManufacturerId>
<Note>sample string 16</Note>
<Notifications>
<Notification>
<Id>12</Id>
<Active>true</Active>
<CommentText>sample string 5</CommentText>
<Confirmed>2025-12-08T14:26:38.0241102+00:00</Confirmed>
<ConfirmedByUserId>10</ConfirmedByUserId>
<EndDate>2025-12-08T14:26:38.0241102+00:00</EndDate>
<EscalationCount>3</EscalationCount>
<Message>sample string 11</Message>
<Name>sample string 1</Name>
<RecipientUserIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:int>1</d6p1:int>
<d6p1:int>2</d6p1:int>
</RecipientUserIds>
<ReminderCount>2</ReminderCount>
<StartDate>2025-12-08T14:26:38.0241102+00:00</StartDate>
<Type>sample string 9</Type>
</Notification>
<Notification>
<Id>12</Id>
<Active>true</Active>
<CommentText>sample string 5</CommentText>
<Confirmed>2025-12-08T14:26:38.0241102+00:00</Confirmed>
<ConfirmedByUserId>10</ConfirmedByUserId>
<EndDate>2025-12-08T14:26:38.0241102+00:00</EndDate>
<EscalationCount>3</EscalationCount>
<Message>sample string 11</Message>
<Name>sample string 1</Name>
<RecipientUserIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:int>1</d6p1:int>
<d6p1:int>2</d6p1:int>
</RecipientUserIds>
<ReminderCount>2</ReminderCount>
<StartDate>2025-12-08T14:26:38.0241102+00:00</StartDate>
<Type>sample string 9</Type>
</Notification>
</Notifications>
<Nr>sample string 2</Nr>
<OrgUnitId>6</OrgUnitId>
<Reference>sample string 13</Reference>
<RelatedContractIds>
<RelatedIdentity>
<Id>2</Id>
<External>true</External>
</RelatedIdentity>
<RelatedIdentity>
<Id>2</Id>
<External>true</External>
</RelatedIdentity>
</RelatedContractIds>
<RelatedInventoryIds>
<RelatedIdentity>
<Id>2</Id>
<External>true</External>
</RelatedIdentity>
<RelatedIdentity>
<Id>2</Id>
<External>true</External>
</RelatedIdentity>
</RelatedInventoryIds>
<ResponsibleUserId>8</ResponsibleUserId>
<Serial>sample string 1</Serial>
<TagIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>1</d4p1:int>
<d4p1:int>2</d4p1:int>
</TagIds>
<WarrantyEndDate>2025-12-08T14:26:38.0241102+00:00</WarrantyEndDate>
<WarrantyStartDate>2025-12-08T14:26:38.0241102+00:00</WarrantyStartDate>
</Inventory>
</Items>
<TotalCount>1</TotalCount>
</ListResultOfInventoryHWVxl9UY>