InventoryTags

List all inventory tags

GET

https://api.gosmarter.ai

/api/company/{companyId}/tags

Retrieves all inventory tags for the specified company, including usage counts.

List all inventory tags › path Parameters

companyId

string · uuid · required

The unique identifier of the company

List all inventory tags › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

List all inventory tags › Responses

List of inventory tags with usage counts

metaInventoryTagDto[]

metaInventoryTagDto

createdAt

string · date-time

Timestamp when the tag was created (UTC)

updatedAt

string · date-time

Timestamp when the tag was last updated (UTC)

usageCount

integer · int32

Number of inventory items currently assigned this tag

tagId

string · uuid

Unique identifier for the tag

companyId

string · uuid

Identifier of the owning company

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

Create new inventory tag

POST

https://api.gosmarter.ai

/api/company/{companyId}/tags

Creates a new inventory tag for the specified company.

Create new inventory tag › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Create new inventory tag › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Create new inventory tag › Request Body

createInventoryTagDto

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

Create new inventory tag › Responses

Tag created successfully

inventoryTagDto

tagId

string · uuid

Unique identifier for the tag

companyId

string · uuid

Identifier of the owning company

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

Get inventory tag

GET

https://api.gosmarter.ai

/api/company/{companyId}/tags/{tagId}

Retrieves a specific inventory tag by ID with usage count.

Get inventory tag › path Parameters

companyId

string · uuid · required

The unique identifier of the company

tagId

string · uuid · required

The unique identifier of the tag

Get inventory tag › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get inventory tag › Responses

The inventory tag with usage count

metaInventoryTagDto

createdAt

string · date-time

Timestamp when the tag was created (UTC)

updatedAt

string · date-time

Timestamp when the tag was last updated (UTC)

usageCount

integer · int32

Number of inventory items currently assigned this tag

tagId

string · uuid

Unique identifier for the tag

companyId

string · uuid

Identifier of the owning company

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

Update inventory tag

PUT

https://api.gosmarter.ai

/api/company/{companyId}/tags/{tagId}

Updates an existing inventory tag. Changes to name and color will be reflected everywhere the tag appears.

Update inventory tag › path Parameters

companyId

string · uuid · required

The unique identifier of the company

tagId

string · uuid · required

The unique identifier of the tag

Update inventory tag › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Update inventory tag › Request Body

createInventoryTagDto

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

Update inventory tag › Responses

Tag updated successfully

inventoryTagDto

tagId

string · uuid

Unique identifier for the tag

companyId

string · uuid

Identifier of the owning company

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

Soft-delete inventory tag

DELETE

https://api.gosmarter.ai

/api/company/{companyId}/tags/{tagId}

Soft-deletes an inventory tag and all its active assignments. The tag can be restored via the restore endpoint.

Soft-delete inventory tag › path Parameters

companyId

string · uuid · required

The unique identifier of the company

tagId

string · uuid · required

The unique identifier of the tag

Soft-delete inventory tag › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Soft-delete inventory tag › Responses

Tag soft-deleted successfully

No data returned

Get inventory tag change history

GET

https://api.gosmarter.ai

/api/company/{companyId}/tags/{tagId}/history

Returns the full temporal audit history for an inventory tag, most recent changes first.

Get inventory tag change history › path Parameters

companyId

string · uuid · required

The unique identifier of the company

tagId

string · uuid · required

The unique identifier of the tag

Get inventory tag change history › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get inventory tag change history › Responses

Audit history returned successfully

auditEventDto[]

auditEventDto

changedAt

string · date-time

changedById

string · uuid

changedByName

string

changeType

string

auditFieldChange[]

entityType

string

entityLabel

string

List deleted inventory tags

GET

https://api.gosmarter.ai

/api/company/{companyId}/tags/deleted

Retrieves all soft-deleted inventory tags for the specified company.

List deleted inventory tags › path Parameters

companyId

string · uuid · required

The unique identifier of the company

List deleted inventory tags › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

List deleted inventory tags › Responses

List of soft-deleted inventory tags

metaInventoryTagDto[]

metaInventoryTagDto

createdAt

string · date-time

Timestamp when the tag was created (UTC)

updatedAt

string · date-time

Timestamp when the tag was last updated (UTC)

usageCount

integer · int32

Number of inventory items currently assigned this tag

tagId

string · uuid

Unique identifier for the tag

companyId

string · uuid

Identifier of the owning company

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

Restore soft-deleted inventory tag

POST

https://api.gosmarter.ai

/api/company/{companyId}/tags/{tagId}/restore

Restores a soft-deleted inventory tag and re-activates its assignments for inventory items that are still active.

Restore soft-deleted inventory tag › path Parameters

companyId

string · uuid · required

The unique identifier of the company

tagId

string · uuid · required

The unique identifier of the tag to restore

Restore soft-deleted inventory tag › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Restore soft-deleted inventory tag › Responses

Tag restored successfully

inventoryTagDto

tagId

string · uuid

Unique identifier for the tag

companyId

string · uuid

Identifier of the owning company

name

string

Tag name (must be unique within company)

color

string

Hex color code for the tag (e.g., #FF5733)

description

string

Optional description of the tag's purpose

List inventory tag assignments

GET

https://api.gosmarter.ai

/api/company/{companyId}/inventory-tag-assignments

Returns all tag assignments for inventory items in the specified company.

List inventory tag assignments › path Parameters

companyId

string · uuid · required

The unique identifier of the company

List inventory tag assignments › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

List inventory tag assignments › Responses

List of tag assignments

inventoryTagAssignmentTagDto[]

inventoryTagAssignmentTagDto

inventoryId

string · uuid

The inventory item identifier

tagId

string · uuid

Unique identifier for the tag

companyId

string · uuid

Identifier of the owning company

name

string

Tag name

color

string

Hex color code for the tag

description

string

Optional description of the tag

Set manual tag assignments

PUT

https://api.gosmarter.ai

/api/company/{companyId}/inventory-slim/{inventoryId}/tags/manual

Replaces all manual tag assignments for an inventory item with the provided set. Rule-based assignments are not affected. Pass an empty list to clear all manual tags.

Set manual tag assignments › path Parameters

companyId

string · uuid · required

The unique identifier of the company

inventoryId

string · uuid · required

The unique identifier of the inventory item

Set manual tag assignments › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Set manual tag assignments › Request Body

setManualTagsRequest

tagIds

string[]

Set manual tag assignments › Responses

Updated manual tag assignments

inventoryTagAssignmentDto[]

inventoryTagAssignmentDto

assignmentId

string · uuid

Unique identifier for the assignment

inventoryId

string · uuid

Inventory item identifier

tagId

string · uuid

Tag identifier

assignedByRuleId

string · uuid

Rule that assigned this tag (null if manual)

assignedAt

string · date-time

Timestamp when the tag was assigned (UTC)

PUT/api/company/{companyId}/inventory-slim/{inventoryId}/tags/manual

curl https://api.gosmarter.ai/api/company/:companyId/inventory-slim/:inventoryId/tags/manual \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "tagIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'

Example Request Body

{
  "tagIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

json

Example Responses

[
  {
    "assignmentId": "00000000-0000-0000-0000-000000000000",
    "inventoryId": "00000000-0000-0000-0000-000000000000",
    "tagId": "00000000-0000-0000-0000-000000000000",
    "assignedByRuleId": "00000000-0000-0000-0000-000000000000",
    "assignedAt": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Inventory InventoryTagRules