Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getasset.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Tags let you label Business data with structured dimensions (for example Job, Location, or Department) so you can filter, report, and automate workflows consistently across entities. Tagging is a two-step process:
  1. Define tag fields (the dimensions you want to tag by).
  2. Set tag values on entities that support tagging (assign or remove values using each entity’s tags field in the API).

​
Step 1: Create tag fields

A tag field is the name of a dimension (for example "Job"). Tag fields fall into two scopes:
ScopeWhat it means
Global tag fieldsCreated at the tenant level. Every business under the tenant can use these fields.
Business tag fieldsCreated for one specific business. Only that business uses them (for example a field that does not apply tenant-wide).
API (global tag fields) API (see fields available to a business)
  • List Tag Fields for a Business — GET /v0/business/{business_id}/tag-fields
    Use this to discover which tag fields apply to a given business (including global fields and business-specific fields).
The Tag Field object describes the shape returned by the API. Optional: predefined tag values If you want a controlled list of allowed values for a field (instead of only free-form values created when tagging), create Tag Values for that business:

​
Step 2: Tag entities

After the tag field exists, set tags on any entity that supports tagging by sending a tags object on create or update requests. Shape
  • Keys are tag field names (strings), for example "Job" or "Location".
  • Values are tag value names (strings), for example "job-123" or "NYC".
{
  "Job": "job-123",
  "Location": "NYC"
}
The tag field must already exist for that business. If the value string does not exist yet, the API can create the tag value automatically when you save the entity (see entity-specific API docs for details). Removing a tag On update payloads that support merge semantics for tags, set the field’s value to null to clear that tag on the entity. Keys you omit are typically left unchanged. 
{
  "Job": null
}
Examples of entities that support tags Check the request schema for each endpoint: if it includes a tags property, you can use the pattern above.
Questions? Reach out via our Contact form.