API V2 Route: Tag Categories

Last updated: October 5, 2026

General Details:

Endpoint	`/api/v2/tag-categories` and `/api/v2/tag-categories/<id>`
Headers	`Authorization: <JWT>`
HTTP Methods	`GET`
Request Body Format	`N/A`
Response Body Format	`JSON`
Required Scopes	`TAG_CATEGORIES_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
`name`	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
name	string
color	string	Hexadecimal value
isExclusive	boolean	Whether or not the category is exclusive
createdAt	date string	ISO Date string
isFixed	boolean	If true, any instance of this Tag Category will appear in a predefined UI location

Example Collection Response:

{
    "entities": [
        {
            "id": "2",
            "name": "Gender",
            "color": "16770229",
            "isExclusive": true,
            "createdAt": "2025-09-25T13:31:55.052Z",
            "isFixed": true
        },
        {
            "id": "3",
            "name": "LLC",
            "color": "16704226",
            "isExclusive": false,
            "createdAt": "2025-09-25T13:31:55.069Z",
            "isFixed": false
        }
    ],
    "metaData": {
        "agentId": "ab5f95b2-303a-403b-85fd-ab1d0cd8093c",
        "rateLimits": {
            "tenant": {
                "limit": 50,
                "remaining": 49,
                "reset": 1760541324000
            },
            "agent": {
                "limit": 10,
                "remaining": 9,
                "reset": 1760541324000
            }
        },
        "pagination": {
            "offset": 0,
            "limit": 2
        }
    }
}