GET api/v2/items/name/{name}

Get item details by item name

Request Information

URI Parameters

Name	Description	Type	Additional information
name	Name of the item	string	Required

Body Parameters

None.

Response Information

Resource Description

Item details object

ItemDetails

Name	Description	Type	Additional information
parent-item	Parent item details	ItemSimple	None.
name	An name of the item	string	None.
foreign-id	An identifier from remote application	string	None.
group-name	Name of the group this item belong to.	string	None.
state	Item state	AssetStatusType	None.
serial	Unique serial number usually assigned by manufacturer	string	None.
description	Description text	string	None.
comments	Free form text	string	None.
first-use-date	Date this entity was first used	date	None.
create-date	Date this entity was created in the system	date	None.
update-date	Date this entity was updated in the system	date	None.
manufacturer	Manufacturer details	ManufacturerSimple	None.
model	Model details	ModelSimple	None.
class	Class details	ClassOverview	None.
department	Department details which is assigned to this item	DepartmentDetails	None.
project	Project details which is assigned to this item	ProjectDetails	None.
custodian	Custodian details	UserSimple	None.
created-by	Custodian details	UserSimple	None.
tags	Tags associated with the item	Collection of TagDetails	None.
attributes	Attributes meta and values associated with the item	Collection of AttributeValueDetails	None.
status	Status (active or not)	TagvueEntityStatus	None.
entity-id	Identifying entity-id of the entity, this is expected to be unique	string	None.

Response Formats

application/xml, text/xml

Sample:

<item entity-id="sample string 9" xmlns="urn:tagvue:am">
  <status>inactive</status>
  <parent-item entity-id="sample string 2">
    <name>sample string 1</name>
  </parent-item>
  <name>sample string 1</name>
  <foreign-id>sample string 2</foreign-id>
  <group-name>sample string 3</group-name>
  <state>NotReceived</state>
  <serial>sample string 4</serial>
  <description>sample string 5</description>
  <comments>sample string 6</comments>
  <first-use-date>2025-11-08T04:35:50.4000865-08:00</first-use-date>
  <create-date>2025-11-08T04:35:50.4000865-08:00</create-date>
  <update-date>2025-11-08T04:35:50.4000865-08:00</update-date>
  <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>
  <class entity-id="sample string 4">
    <status>inactive</status>
    <parent-class entity-id="sample string 2">
      <name>sample string 1</name>
    </parent-class>
    <name>sample string 1</name>
    <create-date>2025-11-08T04:35:50.4000865-08:00</create-date>
    <update-date>2025-11-08T04:35:50.4000865-08:00</update-date>
  </class>
  <department entity-id="sample string 4">
    <status>inactive</status>
    <name>sample string 1</name>
    <code>sample string 2</code>
    <update-date>2025-11-08T04:35:50.4000865-08:00</update-date>
  </department>
  <project entity-id="sample string 4">
    <status>inactive</status>
    <name>sample string 1</name>
    <code>sample string 2</code>
    <update-date>2025-11-08T04:35:50.4000865-08:00</update-date>
  </project>
  <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>
  <created-by 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>
  </created-by>
  <tags>
    <tag entity-id="sample string 3">
      <status>inactive</status>
      <last-seen-time>2025-11-08T04:35:50.4000865-08:00</last-seen-time>
      <last-seen-location entity-id="sample string 2">
        <name>sample string 1</name>
      </last-seen-location>
      <previous-location entity-id="sample string 2">
        <name>sample string 1</name>
      </previous-location>
      <tag-status-user 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>
      </tag-status-user>
      <enrolled-by 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>
      </enrolled-by>
      <latitude>1.1</latitude>
      <longitude>1.1</longitude>
      <disposition>unknown</disposition>
      <type>Barcode</type>
      <create-date>2025-11-08T04:35:50.4000865-08:00</create-date>
      <update-date>2025-11-08T04:35:50.4000865-08:00</update-date>
      <entity entity-id="sample string 1" type="None" />
    </tag>
    <tag entity-id="sample string 3">
      <status>inactive</status>
      <last-seen-time>2025-11-08T04:35:50.4000865-08:00</last-seen-time>
      <last-seen-location entity-id="sample string 2">
        <name>sample string 1</name>
      </last-seen-location>
      <previous-location entity-id="sample string 2">
        <name>sample string 1</name>
      </previous-location>
      <tag-status-user 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>
      </tag-status-user>
      <enrolled-by 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>
      </enrolled-by>
      <latitude>1.1</latitude>
      <longitude>1.1</longitude>
      <disposition>unknown</disposition>
      <type>Barcode</type>
      <create-date>2025-11-08T04:35:50.4000865-08:00</create-date>
      <update-date>2025-11-08T04:35:50.4000865-08:00</update-date>
      <entity entity-id="sample string 1" type="None" />
    </tag>
  </tags>
  <attributes>
    <attribute entity-id="sample string 3">
      <status>inactive</status>
      <meta-data entity-id="sample string 6">
        <status>inactive</status>
        <name>sample string 1</name>
        <type>Number</type>
        <unit-type>sample string 2</unit-type>
        <possible-values>sample string 3</possible-values>
        <sort-order>1</sort-order>
        <searchable>true</searchable>
        <update-date>2025-11-08T04:35:50.4000865-08:00</update-date>
        <class entity-id="sample string 2">
          <name>sample string 1</name>
        </class>
      </meta-data>
      <value>sample string 1</value>
      <update-date>sample string 2</update-date>
    </attribute>
    <attribute entity-id="sample string 3">
      <status>inactive</status>
      <meta-data entity-id="sample string 6">
        <status>inactive</status>
        <name>sample string 1</name>
        <type>Number</type>
        <unit-type>sample string 2</unit-type>
        <possible-values>sample string 3</possible-values>
        <sort-order>1</sort-order>
        <searchable>true</searchable>
        <update-date>2025-11-08T04:35:50.4000865-08:00</update-date>
        <class entity-id="sample string 2">
          <name>sample string 1</name>
        </class>
      </meta-data>
      <value>sample string 1</value>
      <update-date>sample string 2</update-date>
    </attribute>
  </attributes>
</item>

application/json, text/json

Sample:

{
  "parent-item": {
    "name": "sample string 1",
    "entity-id": "sample string 2"
  },
  "name": "sample string 1",
  "foreign-id": "sample string 2",
  "group-name": "sample string 3",
  "state": "notreceived",
  "serial": "sample string 4",
  "description": "sample string 5",
  "comments": "sample string 6",
  "first-use-date": "2025-11-08T04:35:50.4000865-08:00",
  "create-date": "2025-11-08T04:35:50.4000865-08:00",
  "update-date": "2025-11-08T04:35:50.4000865-08: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"
  },
  "class": {
    "parent-class": {
      "name": "sample string 1",
      "entity-id": "sample string 2"
    },
    "name": "sample string 1",
    "create-date": "2025-11-08T04:35:50.4000865-08:00",
    "update-date": "2025-11-08T04:35:50.4000865-08:00",
    "status": 0,
    "entity-id": "sample string 4"
  },
  "department": {
    "Name": "sample string 1",
    "Code": "sample string 2",
    "UpdateDate": "2025-11-08T04:35:50.4000865-08:00",
    "status": 0,
    "entity-id": "sample string 4"
  },
  "project": {
    "name": "sample string 1",
    "code": "sample string 2",
    "update-date": "2025-11-08T04:35:50.4000865-08:00",
    "status": 0,
    "entity-id": "sample string 4"
  },
  "custodian": {
    "entity-id": "sample string 1",
    "name": "sample string 2",
    "email": "sample string 3",
    "employee-id": "sample string 4",
    "phone": "sample string 5"
  },
  "created-by": {
    "entity-id": "sample string 1",
    "name": "sample string 2",
    "email": "sample string 3",
    "employee-id": "sample string 4",
    "phone": "sample string 5"
  },
  "tags": [
    {
      "last-seen-time": "2025-11-08T04:35:50.4000865-08:00",
      "last-seen-location": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "previous-location": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "tag-status-user": {
        "entity-id": "sample string 1",
        "name": "sample string 2",
        "email": "sample string 3",
        "employee-id": "sample string 4",
        "phone": "sample string 5"
      },
      "enrolled-by": {
        "entity-id": "sample string 1",
        "name": "sample string 2",
        "email": "sample string 3",
        "employee-id": "sample string 4",
        "phone": "sample string 5"
      },
      "latitude": 1.1,
      "longitude": 1.1,
      "disposition": 0,
      "type": 0,
      "create-date": "2025-11-08T04:35:50.4000865-08:00",
      "update-date": "2025-11-08T04:35:50.4000865-08:00",
      "entity": {
        "Id": "sample string 1",
        "Type": 0
      },
      "status": 0,
      "entity-id": "sample string 3"
    },
    {
      "last-seen-time": "2025-11-08T04:35:50.4000865-08:00",
      "last-seen-location": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "previous-location": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "tag-status-user": {
        "entity-id": "sample string 1",
        "name": "sample string 2",
        "email": "sample string 3",
        "employee-id": "sample string 4",
        "phone": "sample string 5"
      },
      "enrolled-by": {
        "entity-id": "sample string 1",
        "name": "sample string 2",
        "email": "sample string 3",
        "employee-id": "sample string 4",
        "phone": "sample string 5"
      },
      "latitude": 1.1,
      "longitude": 1.1,
      "disposition": 0,
      "type": 0,
      "create-date": "2025-11-08T04:35:50.4000865-08:00",
      "update-date": "2025-11-08T04:35:50.4000865-08:00",
      "entity": {
        "Id": "sample string 1",
        "Type": 0
      },
      "status": 0,
      "entity-id": "sample string 3"
    }
  ],
  "attributes": [
    {
      "metadata": {
        "name": "sample string 1",
        "type": "Number",
        "unit-type": "sample string 2",
        "possible-values": "sample string 3",
        "sort-order": 1,
        "searchable": true,
        "update-date": "2025-11-08T04:35:50.4000865-08:00",
        "class": {
          "name": "sample string 1",
          "entity-id": "sample string 2"
        },
        "status": 0,
        "entity-id": "sample string 6"
      },
      "value": "sample string 1",
      "update-date": "sample string 2",
      "status": 0,
      "entity-id": "sample string 3"
    },
    {
      "metadata": {
        "name": "sample string 1",
        "type": "Number",
        "unit-type": "sample string 2",
        "possible-values": "sample string 3",
        "sort-order": 1,
        "searchable": true,
        "update-date": "2025-11-08T04:35:50.4000865-08:00",
        "class": {
          "name": "sample string 1",
          "entity-id": "sample string 2"
        },
        "status": 0,
        "entity-id": "sample string 6"
      },
      "value": "sample string 1",
      "update-date": "sample string 2",
      "status": 0,
      "entity-id": "sample string 3"
    }
  ],
  "status": 0,
  "entity-id": "sample string 9"
}