GET api/v2/items

Get all items by specified filters. Filters are not case-sensitive. If more than one filter provided, they will be combined with AND operator.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
AssetClassEntityId

Item class entity ID. Single value or comma-delimited list of values. If provided, result set will contain only items of these classes (categpries).

 string

None.
Attribute

Filter by item attribute. Optional, can be provided multiple times. The value of the parameter is colon-delimited pair of attribute name and value (Ex. CPU:Intel). First colon is used to separate name and value, other colons ignored.

 Collection of string

None.
CustodianEmployeeId

EmployeeID of the item custodian. Single value or comma-delimited list of values. If provided, result set will contain only items which are in custody of this person. if CustodianEntityId provided, this value is ignored.

 string

None.
CustodianEntityId

Username of the item custodian. Single value or comma-delimited list of values. If provided, result set will contain only items which are in custody of this person.

 string

None.
DepartmentEntityId

Filter by item department.

 string

None.
Expired

If provided indicates whether method should return expired or not expired items based on expiration time property. If omitted, method does not check expiration time.

 boolean

None.
Fields

Comma-delimited list of additional fields to return. Additional fields make query heavier. It is a good practice to query only what you need. Valid values: attributes - item attributes

 string

None.
IgnoreLocationChanges

Optional. If provided, result set will skip items which have only location info changed.

 boolean

None.
ItemState

Item state. Single value or comma-delimited list of states. If provided, item state should contain this value(s) among its states. This parameter may be provided multiple times. In such case item state should contain the whole value of any one parameter from the list. Note: item state may have multiple values at the same time, for example "InService,Submitted" or "InService,Processed'.

 Collection of AssetStatusType

None.
ItemStateOnly

Item state. Single value or comma-delimited list of states. If provided, item state should be equal to this value(s). This parameter may be provided multiple times. In such case item state should be equal to the whole value of any one parameter from the list. Note: item state may have multiple values at the same time, for example "InService,Submitted" or "InService,Processed'.

 Collection of AssetStatusType

None.
LastSeenLocationEntityId

Filter by last seen location id

 string

None.
ManufacturerEntityId

Filter by item manufacturer

 string

None.
ModelEntityId

Filter by item model

 string

None.
ProjectEntityId

Filter by project. If provided, item should have project with this entityID. If asterisk "*" provided, item should have any project assigned.

 string

None.
Serial

Filter by item serial

 string

None.
TagEndsWith

Return items with tags end with provided text.

 string

None.
Skip

Number of items you want to skip in the search (optional)

 integer

None.
Take

Number of items to return in the result set of the search operation (optional)

 integer

None.
Since

Return only items which have Update-Date greater then (optional)

 date

None.
Name

Filter by entity name (if applicable)

 string

None.

Body Parameters

None.

Response Information

Resource Description

Item collection

ItemOverviewList
NameDescriptionTypeAdditional information
items

Item collections

 Collection of ItemOverview

None.

Response Formats

application/xml, text/xml

Sample: 
<items xmlns="urn:tagvue:am">
  <item entity-id="sample string 7">
    <status>inactive</status>
    <name>sample string 1</name>
    <description>sample string 2</description>
    <group-name>sample string 3</group-name>
    <state>NotReceived</state>
    <serial>sample string 4</serial>
    <create-date>2025-05-30T20:18:43.953004-07:00</create-date>
    <update-date>2025-05-30T20:18:43.953004-07:00</update-date>
    <first-use-time>2025-05-30T20:18:43.953004-07:00</first-use-time>
    <attributes>
      <attribute entity-id="sample string 3">
        <name>sample string 1</name>
        <type>Number</type>
        <value>sample string 2</value>
        <person entity-id="sample string 1">
          <name>sample string 2</name>
          <email>sample string 3</email>
          <employee-id>sample string 4</employee-id>
          <phone>sample string 5</phone>
        </person>
      </attribute>
      <attribute entity-id="sample string 3">
        <name>sample string 1</name>
        <type>Number</type>
        <value>sample string 2</value>
        <person entity-id="sample string 1">
          <name>sample string 2</name>
          <email>sample string 3</email>
          <employee-id>sample string 4</employee-id>
          <phone>sample string 5</phone>
        </person>
      </attribute>
    </attributes>
    <class entity-id="sample string 2">
      <name>sample string 1</name>
    </class>
    <department entity-id="sample string 3">
      <name>sample string 1</name>
      <code>sample string 2</code>
    </department>
    <last-seen-location entity-id="sample string 2">
      <name>sample string 1</name>
    </last-seen-location>
    <last-seen-time>2025-05-30T20:18:43.953004-07:00</last-seen-time>
    <manufacturer entity-id="sample string 2">
      <name>sample string 1</name>
    </manufacturer>
    <model entity-id="sample string 3">
      <name>sample string 1</name>
      <code>sample string 2</code>
    </model>
    <expected-location entity-id="sample string 2">
      <name>sample string 1</name>
    </expected-location>
    <project entity-id="sample string 3">
      <name>sample string 1</name>
      <code>sample string 2</code>
    </project>
    <parent entity-id="sample string 2">
      <name>sample string 1</name>
    </parent>
    <tags>
      <tag entity-id="sample string 2">
        <status>inactive</status>
        <last-seen-time>2025-05-30T20:18:43.953004-07:00</last-seen-time>
        <last-seen-location entity-id="sample string 1" />
        <last-seen-provider>1</last-seen-provider>
        <latitude>1.1</latitude>
        <longitude>1.1</longitude>
        <last-seen-x-coordinate>1.1</last-seen-x-coordinate>
        <last-seen-y-coordinate>1.1</last-seen-y-coordinate>
      </tag>
      <tag entity-id="sample string 2">
        <status>inactive</status>
        <last-seen-time>2025-05-30T20:18:43.953004-07:00</last-seen-time>
        <last-seen-location entity-id="sample string 1" />
        <last-seen-provider>1</last-seen-provider>
        <latitude>1.1</latitude>
        <longitude>1.1</longitude>
        <last-seen-x-coordinate>1.1</last-seen-x-coordinate>
        <last-seen-y-coordinate>1.1</last-seen-y-coordinate>
      </tag>
    </tags>
    <custodian entity-id="sample string 1">
      <name>sample string 2</name>
      <email>sample string 3</email>
      <employee-id>sample string 4</employee-id>
      <phone>sample string 5</phone>
    </custodian>
  </item>
  <item entity-id="sample string 7">
    <status>inactive</status>
    <name>sample string 1</name>
    <description>sample string 2</description>
    <group-name>sample string 3</group-name>
    <state>NotReceived</state>
    <serial>sample string 4</serial>
    <create-date>2025-05-30T20:18:43.953004-07:00</create-date>
    <update-date>2025-05-30T20:18:43.953004-07:00</update-date>
    <first-use-time>2025-05-30T20:18:43.953004-07:00</first-use-time>
    <attributes>
      <attribute entity-id="sample string 3">
        <name>sample string 1</name>
        <type>Number</type>
        <value>sample string 2</value>
        <person entity-id="sample string 1">
          <name>sample string 2</name>
          <email>sample string 3</email>
          <employee-id>sample string 4</employee-id>
          <phone>sample string 5</phone>
        </person>
      </attribute>
      <attribute entity-id="sample string 3">
        <name>sample string 1</name>
        <type>Number</type>
        <value>sample string 2</value>
        <person entity-id="sample string 1">
          <name>sample string 2</name>
          <email>sample string 3</email>
          <employee-id>sample string 4</employee-id>
          <phone>sample string 5</phone>
        </person>
      </attribute>
    </attributes>
    <class entity-id="sample string 2">
      <name>sample string 1</name>
    </class>
    <department entity-id="sample string 3">
      <name>sample string 1</name>
      <code>sample string 2</code>
    </department>
    <last-seen-location entity-id="sample string 2">
      <name>sample string 1</name>
    </last-seen-location>
    <last-seen-time>2025-05-30T20:18:43.953004-07:00</last-seen-time>
    <manufacturer entity-id="sample string 2">
      <name>sample string 1</name>
    </manufacturer>
    <model entity-id="sample string 3">
      <name>sample string 1</name>
      <code>sample string 2</code>
    </model>
    <expected-location entity-id="sample string 2">
      <name>sample string 1</name>
    </expected-location>
    <project entity-id="sample string 3">
      <name>sample string 1</name>
      <code>sample string 2</code>
    </project>
    <parent entity-id="sample string 2">
      <name>sample string 1</name>
    </parent>
    <tags>
      <tag entity-id="sample string 2">
        <status>inactive</status>
        <last-seen-time>2025-05-30T20:18:43.953004-07:00</last-seen-time>
        <last-seen-location entity-id="sample string 1" />
        <last-seen-provider>1</last-seen-provider>
        <latitude>1.1</latitude>
        <longitude>1.1</longitude>
        <last-seen-x-coordinate>1.1</last-seen-x-coordinate>
        <last-seen-y-coordinate>1.1</last-seen-y-coordinate>
      </tag>
      <tag entity-id="sample string 2">
        <status>inactive</status>
        <last-seen-time>2025-05-30T20:18:43.953004-07:00</last-seen-time>
        <last-seen-location entity-id="sample string 1" />
        <last-seen-provider>1</last-seen-provider>
        <latitude>1.1</latitude>
        <longitude>1.1</longitude>
        <last-seen-x-coordinate>1.1</last-seen-x-coordinate>
        <last-seen-y-coordinate>1.1</last-seen-y-coordinate>
      </tag>
    </tags>
    <custodian entity-id="sample string 1">
      <name>sample string 2</name>
      <email>sample string 3</email>
      <employee-id>sample string 4</employee-id>
      <phone>sample string 5</phone>
    </custodian>
  </item>
</items>

application/json, text/json

Sample: 
{
  "items": [
    {
      "name": "sample string 1",
      "description": "sample string 2",
      "group-name": "sample string 3",
      "state": "notreceived",
      "serial": "sample string 4",
      "create-date": "2025-05-30T20:18:43.953004-07:00",
      "update-date": "2025-05-30T20:18:43.953004-07:00",
      "first-use-time": "2025-05-30T20:18:43.953004-07:00",
      "attributes": [
        {
          "name": "sample string 1",
          "type": "Number",
          "value": "sample string 2",
          "person": {
            "entity-id": "sample string 1",
            "name": "sample string 2",
            "email": "sample string 3",
            "employee-id": "sample string 4",
            "phone": "sample string 5"
          },
          "entity-id": "sample string 3"
        },
        {
          "name": "sample string 1",
          "type": "Number",
          "value": "sample string 2",
          "person": {
            "entity-id": "sample string 1",
            "name": "sample string 2",
            "email": "sample string 3",
            "employee-id": "sample string 4",
            "phone": "sample string 5"
          },
          "entity-id": "sample string 3"
        }
      ],
      "class": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "department": {
        "name": "sample string 1",
        "code": "sample string 2",
        "entity-id": "sample string 3"
      },
      "last-seen-location": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "last-seen-time": "2025-05-30T20:18:43.953004-07:00",
      "manufacturer": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "model": {
        "name": "sample string 1",
        "code": "sample string 2",
        "entity-id": "sample string 3"
      },
      "expected-location": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "project": {
        "name": "sample string 1",
        "code": "sample string 2",
        "entity-id": "sample string 3"
      },
      "parent": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "tags": [
        {
          "last-seen-time": "2025-05-30T20:18:43.953004-07:00",
          "last-seen-location": {
            "entity-id": "sample string 1"
          },
          "last-seen-provider": 1,
          "latitude": 1.1,
          "longitude": 1.1,
          "last-seen-x-coordinate": 1.1,
          "last-seen-y-coordinate": 1.1,
          "status": 0,
          "entity-id": "sample string 2"
        },
        {
          "last-seen-time": "2025-05-30T20:18:43.953004-07:00",
          "last-seen-location": {
            "entity-id": "sample string 1"
          },
          "last-seen-provider": 1,
          "latitude": 1.1,
          "longitude": 1.1,
          "last-seen-x-coordinate": 1.1,
          "last-seen-y-coordinate": 1.1,
          "status": 0,
          "entity-id": "sample string 2"
        }
      ],
      "custodian": {
        "entity-id": "sample string 1",
        "name": "sample string 2",
        "email": "sample string 3",
        "employee-id": "sample string 4",
        "phone": "sample string 5"
      },
      "status": 0,
      "entity-id": "sample string 7"
    },
    {
      "name": "sample string 1",
      "description": "sample string 2",
      "group-name": "sample string 3",
      "state": "notreceived",
      "serial": "sample string 4",
      "create-date": "2025-05-30T20:18:43.953004-07:00",
      "update-date": "2025-05-30T20:18:43.953004-07:00",
      "first-use-time": "2025-05-30T20:18:43.953004-07:00",
      "attributes": [
        {
          "name": "sample string 1",
          "type": "Number",
          "value": "sample string 2",
          "person": {
            "entity-id": "sample string 1",
            "name": "sample string 2",
            "email": "sample string 3",
            "employee-id": "sample string 4",
            "phone": "sample string 5"
          },
          "entity-id": "sample string 3"
        },
        {
          "name": "sample string 1",
          "type": "Number",
          "value": "sample string 2",
          "person": {
            "entity-id": "sample string 1",
            "name": "sample string 2",
            "email": "sample string 3",
            "employee-id": "sample string 4",
            "phone": "sample string 5"
          },
          "entity-id": "sample string 3"
        }
      ],
      "class": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "department": {
        "name": "sample string 1",
        "code": "sample string 2",
        "entity-id": "sample string 3"
      },
      "last-seen-location": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "last-seen-time": "2025-05-30T20:18:43.953004-07:00",
      "manufacturer": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "model": {
        "name": "sample string 1",
        "code": "sample string 2",
        "entity-id": "sample string 3"
      },
      "expected-location": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "project": {
        "name": "sample string 1",
        "code": "sample string 2",
        "entity-id": "sample string 3"
      },
      "parent": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "tags": [
        {
          "last-seen-time": "2025-05-30T20:18:43.953004-07:00",
          "last-seen-location": {
            "entity-id": "sample string 1"
          },
          "last-seen-provider": 1,
          "latitude": 1.1,
          "longitude": 1.1,
          "last-seen-x-coordinate": 1.1,
          "last-seen-y-coordinate": 1.1,
          "status": 0,
          "entity-id": "sample string 2"
        },
        {
          "last-seen-time": "2025-05-30T20:18:43.953004-07:00",
          "last-seen-location": {
            "entity-id": "sample string 1"
          },
          "last-seen-provider": 1,
          "latitude": 1.1,
          "longitude": 1.1,
          "last-seen-x-coordinate": 1.1,
          "last-seen-y-coordinate": 1.1,
          "status": 0,
          "entity-id": "sample string 2"
        }
      ],
      "custodian": {
        "entity-id": "sample string 1",
        "name": "sample string 2",
        "email": "sample string 3",
        "employee-id": "sample string 4",
        "phone": "sample string 5"
      },
      "status": 0,
      "entity-id": "sample string 7"
    }
  ]
}