API V2 Route: Tags

Last updated: October 5, 2026

General Details:

Endpoint /api/v2/tags and /api/v2/tags/<id>
Headers Authorization: <JWT>
HTTP Methods GET
Request Body Format N/A
Response Body Format JSON
Required Scopes
TAG_GET

 

Supported Request Filters:

These filters should be query parts in the URL string and follow the standard pattern of <baseUrl>?<key>=<filter>&...

Field Name Filter Type Notes
caption string or String Filter A string or complex string filter can be utilized

 

API Response:

Field Name Data Type Notes
id string Globally unique identifier
caption string  
color string Hexadecimal value
isPublic boolean  
isDeprecated boolean  
createdAt date string ISO date string
applicabilityType enum See values below*
category CategoryThin or null  

 

Applicability Types

The type defines which entity type within Housing.Cloud can receive an instance of this tag

Applicability Type Tag-gable Entity
PROFILE_APP Profiles and Applications
INVENTORY Inventory
TASK Task
COMMUNICATIONS Communication

 

Example Collection Response:

{
    "entities": [
        {
            "id": "3",
            "caption": "Male",
            "color": "11393254",
            "isPublic": false,
            "isDeprecated": false,
            "applicabilityType": [
                "PROFILE_APP",
                "INVENTORY"
            ],
            "category": {
                "id": "2",
                "name": "Gender"
            },
            "createdAt": "2025-09-25T13:31:55.056Z"
        },
        {
            "id": "4",
            "caption": "Female",
            "color": "16758465",
            "isPublic": false,
            "isDeprecated": false,
            "applicabilityType": [
                "PROFILE_APP",
                "INVENTORY"
            ],
            "category": {
                "id": "2",
                "name": "Gender"
            },
            "createdAt": "2025-09-25T13:31:55.057Z"
        },
        {
            "id": "5",
            "caption": "Athlete-Soccer",
            "color": "14742270",
            "isPublic": false,
            "isDeprecated": false,
            "applicabilityType": [
                "PROFILE_APP",
                "INVENTORY",
                "TASK",
                "COMMUNICATION"
            ],
            "category": {
                "id": "3",
                "name": "LLC"
            },
            "createdAt": "2025-09-25T13:31:55.070Z"
        }
    ],
    "metaData": {
        "agentId": "ab5f95b2-303a-403b-85fd-ab1d0cd8093c",
        "rateLimits": {
            "tenant": {
                "limit": 50,
                "remaining": 49,
                "reset": 1760543060000
            },
            "agent": {
                "limit": 10,
                "remaining": 9,
                "reset": 1760543060000
            }
        },
        "pagination": {
            "offset": 0,
            "limit": 3
        }
    }
}