---
updatedAt: 2026-05-28T22:56:20.000Z
agentTools:
  projectIndex: https://docs.constructor.com/llms.txt
---

# Retrieve refined tag

**🔐 This endpoint requires [HTTP authentication](https://docs.constructor.com/reference/main-authentication) (either [Basic](https://docs.constructor.com/reference/main-authentication#basic-authentication) or [Bearer](https://docs.constructor.com/reference/main-authentication#bearer-authentication)).**
For authenticating with Bearer token, required scopes are: `searchandising.refined_tags(r)`.

Retrieve a refined tag.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "contact": {
      "email": "support@constructor.io"
    },
    "title": "Searchandising",
    "version": "0.1"
  },
  "servers": [
    {
      "url": "https://ac.cnstrc.com"
    }
  ],
  "security": [],
  "tags": [
    {
      "name": "Searchandising by User Request Data"
    }
  ],
  "paths": {
    "/v1/refined_tags/{tag_name}/{tag_value}": {
      "get": {
        "tags": [
          "Searchandising by User Request Data"
        ],
        "operationId": "v1-searchandising-retrieve-refined-tag",
        "summary": "Retrieve refined tag",
        "description": "**🔐 This endpoint requires [HTTP authentication](https://docs.constructor.com/reference/main-authentication) (either [Basic](https://docs.constructor.com/reference/main-authentication#basic-authentication) or [Bearer](https://docs.constructor.com/reference/main-authentication#bearer-authentication)).**\nFor authenticating with Bearer token, required scopes are: `searchandising.refined_tags(r)`.\n\nRetrieve a refined tag.",
        "parameters": [
          {
            "name": "tag_name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "tag_value",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "key",
            "in": "query",
            "schema": {
              "title": "Key",
              "description": "The key of the index to use.",
              "maxLength": 100,
              "minLength": 1,
              "examples": [
                "key_K2pX7vBnU0bgA5xp"
              ],
              "type": "string"
            },
            "required": true
          },
          {
            "name": "section",
            "in": "query",
            "schema": {
              "title": "Section",
              "description": "The section of the index to use. Defaults to `Products`.",
              "maxLength": 100,
              "minLength": 1,
              "examples": [
                "Products",
                "Search Suggestions"
              ],
              "type": "string"
            },
            "required": false
          },
          {
            "name": "c",
            "in": "query",
            "schema": {
              "title": "C",
              "description": "The ID of the client and version that the request is coming from, such as `cio-js-2.90`.",
              "maxLength": 100,
              "minLength": 1,
              "examples": [
                "cio-js-2.90",
                "cio-ios-1.0"
              ],
              "type": "string"
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RefinedTagGetResponse"
                }
              }
            }
          },
          "400": {
            "description": "Validation Error"
          },
          "401": {
            "description": "Credentials are not passed or action is forbidden."
          },
          "403": {
            "description": "The supplied token does not have the required permissions."
          },
          "429": {
            "description": "Rate limit breached"
          }
        },
        "security": [
          {
            "http_basic_auth": []
          },
          {
            "http_bearer_auth": [
              "searchandising.refined_tags(r)"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "RequestTags": {
        "title": "RequestTags",
        "enum": [
          "client_ip",
          "client_version",
          "geo_city",
          "geo_country",
          "geo_country_iso_code",
          "geo_region",
          "dt_weekday",
          "dt_timeofday",
          "user_segment",
          "autogenerated_user_segment",
          "dynamic_segment"
        ],
        "type": "string"
      },
      "FiltersDict": {
        "title": "FiltersDict",
        "default": "JSON contains filters based on items attributes.",
        "type": "object",
        "additionalProperties": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          }
        }
      },
      "WhitelistFiltersRuleParameters": {
        "title": "WhitelistFiltersRuleParameters",
        "type": "object",
        "properties": {
          "filters": {
            "title": "Filters",
            "description": "Any number of criteria by which you'd like to narrow the result set. This might be by color, size, or category (group) an item belongs to.",
            "allOf": [
              {
                "$ref": "#/components/schemas/FiltersDict"
              }
            ]
          }
        },
        "required": [
          "filters"
        ],
        "additionalProperties": false
      },
      "WhitelistRuleResponse": {
        "title": "WhitelistRuleResponse",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "description": "The ID of the rule, must be unique.",
            "type": "integer"
          },
          "request_tag_name": {
            "description": "Request tag name to be used to activate this entity for, used only with `request_tag_value`.",
            "examples": [
              "user_segment",
              "geo_country"
            ],
            "allOf": [
              {
                "$ref": "#/components/schemas/RequestTags"
              }
            ]
          },
          "request_tag_value": {
            "title": "Request Tag Value",
            "description": "Request tag value to be used to activate this entity for, used only with request_tag_name.",
            "maxLength": 100,
            "minLength": 1,
            "examples": [
              "premium",
              "US"
            ],
            "type": "string"
          },
          "active": {
            "title": "Active",
            "description": "Indicates whether this rule is active or not.",
            "examples": [
              true,
              false
            ],
            "type": "boolean"
          },
          "start_time": {
            "title": "Start Time",
            "description": "Date and time when the rule should be enabled.",
            "examples": [
              "2024-03-06T16:05:19"
            ],
            "type": "string",
            "format": "date-time"
          },
          "end_time": {
            "title": "End Time",
            "description": "Date and time when the rule should be disabled.",
            "examples": [
              "2024-03-06T17:05:19"
            ],
            "type": "string",
            "format": "date-time"
          },
          "campaign_id": {
            "title": "Campaign Id",
            "examples": [
              1,
              42
            ],
            "type": "integer"
          },
          "automatically_generated": {
            "title": "Automatically Generated",
            "description": "Boolean to indicate if this rule is automatically generated or not.",
            "examples": [
              false,
              true
            ],
            "type": "boolean"
          },
          "rule": {
            "title": "Rule",
            "description": "Rule definition of the whitelist rule.",
            "allOf": [
              {
                "$ref": "#/components/schemas/WhitelistFiltersRuleParameters"
              }
            ]
          },
          "rule_type": {
            "title": "Rule Type",
            "enum": [
              "whitelist"
            ],
            "type": "string"
          },
          "created_at": {
            "title": "Created At",
            "description": "Date & time in ISO 8601 format for the creation of this rule.",
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "title": "Updated At",
            "description": "Date & time in ISO 8601 format for last update for this rule.",
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "rule",
          "rule_type"
        ]
      },
      "ItemIdsOrFilters": {
        "title": "ItemIdsOrFilters",
        "type": "object",
        "properties": {
          "filters": {
            "title": "Filters",
            "description": "Any number of criteria by which you'd like to narrow the result set. This might be by color, size, or category (group) an item belongs to.",
            "examples": [
              {
                "brand": [
                  "Nike",
                  "Adidas"
                ]
              }
            ],
            "allOf": [
              {
                "$ref": "#/components/schemas/FiltersDict"
              }
            ]
          },
          "item_ids": {
            "title": "Item Ids",
            "description": "The IDs of the items to be recalled.",
            "minItems": 1,
            "type": "array",
            "items": {
              "type": "string",
              "examples": [
                "nike-shoes",
                "product-123"
              ]
            }
          }
        },
        "additionalProperties": false
      },
      "BlacklistRuleResponse": {
        "title": "BlacklistRuleResponse",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "description": "The ID of the rule, must be unique.",
            "type": "integer"
          },
          "request_tag_name": {
            "description": "Request tag name to be used to activate this entity for, used only with `request_tag_value`.",
            "examples": [
              "user_segment",
              "geo_country"
            ],
            "allOf": [
              {
                "$ref": "#/components/schemas/RequestTags"
              }
            ]
          },
          "request_tag_value": {
            "title": "Request Tag Value",
            "description": "Request tag value to be used to activate this entity for, used only with request_tag_name.",
            "maxLength": 100,
            "minLength": 1,
            "examples": [
              "premium",
              "US"
            ],
            "type": "string"
          },
          "active": {
            "title": "Active",
            "description": "Indicates whether this rule is active or not.",
            "examples": [
              true,
              false
            ],
            "type": "boolean"
          },
          "start_time": {
            "title": "Start Time",
            "description": "Date and time when the rule should be enabled.",
            "examples": [
              "2024-03-06T16:05:19"
            ],
            "type": "string",
            "format": "date-time"
          },
          "end_time": {
            "title": "End Time",
            "description": "Date and time when the rule should be disabled.",
            "examples": [
              "2024-03-06T17:05:19"
            ],
            "type": "string",
            "format": "date-time"
          },
          "campaign_id": {
            "title": "Campaign Id",
            "examples": [
              1,
              42
            ],
            "type": "integer"
          },
          "automatically_generated": {
            "title": "Automatically Generated",
            "description": "Boolean to indicate if this rule is automatically generated or not.",
            "examples": [
              false,
              true
            ],
            "type": "boolean"
          },
          "rule": {
            "title": "Rule",
            "description": "Rule definition of the blacklist rule.",
            "allOf": [
              {
                "$ref": "#/components/schemas/ItemIdsOrFilters"
              }
            ]
          },
          "rule_type": {
            "title": "Rule Type",
            "enum": [
              "blacklist"
            ],
            "type": "string"
          },
          "created_at": {
            "title": "Created At",
            "description": "Date & time in ISO 8601 format for the creation of this rule.",
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "title": "Updated At",
            "description": "Date & time in ISO 8601 format for last update for this rule.",
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "rule",
          "rule_type"
        ]
      },
      "BoostRuleDict": {
        "title": "BoostRuleDict",
        "type": "object",
        "properties": {
          "filters": {
            "title": "Filters",
            "description": "Any number of criteria by which you'd like to narrow the result set. This might be by color, size, or category (group) an item belongs to.",
            "examples": [
              {
                "brand": [
                  "Nike",
                  "Adidas"
                ]
              }
            ],
            "allOf": [
              {
                "$ref": "#/components/schemas/FiltersDict"
              }
            ]
          },
          "item_ids": {
            "title": "Item Ids",
            "description": "The IDs of the items to be recalled.",
            "minItems": 1,
            "type": "array",
            "items": {
              "type": "string",
              "examples": [
                "nike-shoes",
                "product-123"
              ]
            }
          },
          "boost": {
            "title": "Boost",
            "description": "Boost factor for this rule.",
            "minimum": -10,
            "maximum": 10,
            "examples": [
              -5,
              5
            ],
            "type": "number"
          }
        },
        "required": [
          "boost"
        ],
        "additionalProperties": false
      },
      "BoostRuleResponse": {
        "title": "BoostRuleResponse",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "description": "The ID of the rule, must be unique.",
            "type": "integer"
          },
          "request_tag_name": {
            "description": "Request tag name to be used to activate this entity for, used only with `request_tag_value`.",
            "examples": [
              "user_segment",
              "geo_country"
            ],
            "allOf": [
              {
                "$ref": "#/components/schemas/RequestTags"
              }
            ]
          },
          "request_tag_value": {
            "title": "Request Tag Value",
            "description": "Request tag value to be used to activate this entity for, used only with request_tag_name.",
            "maxLength": 100,
            "minLength": 1,
            "examples": [
              "premium",
              "US"
            ],
            "type": "string"
          },
          "active": {
            "title": "Active",
            "description": "Indicates whether this rule is active or not.",
            "examples": [
              true,
              false
            ],
            "type": "boolean"
          },
          "start_time": {
            "title": "Start Time",
            "description": "Date and time when the rule should be enabled.",
            "examples": [
              "2024-03-06T16:05:19"
            ],
            "type": "string",
            "format": "date-time"
          },
          "end_time": {
            "title": "End Time",
            "description": "Date and time when the rule should be disabled.",
            "examples": [
              "2024-03-06T17:05:19"
            ],
            "type": "string",
            "format": "date-time"
          },
          "campaign_id": {
            "title": "Campaign Id",
            "examples": [
              1,
              42
            ],
            "type": "integer"
          },
          "automatically_generated": {
            "title": "Automatically Generated",
            "description": "Boolean to indicate if this rule is automatically generated or not.",
            "examples": [
              false,
              true
            ],
            "type": "boolean"
          },
          "rule": {
            "title": "Rule",
            "description": "Rule definition of the boost rule.",
            "allOf": [
              {
                "$ref": "#/components/schemas/BoostRuleDict"
              }
            ]
          },
          "rule_type": {
            "title": "Rule Type",
            "enum": [
              "boost"
            ],
            "type": "string"
          },
          "created_at": {
            "title": "Created At",
            "description": "Date & time in ISO 8601 format for the creation of this rule.",
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "title": "Updated At",
            "description": "Date & time in ISO 8601 format for last update for this rule.",
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "rule",
          "rule_type"
        ]
      },
      "RefinedTagGetResponse": {
        "title": "RefinedTagGetResponse",
        "type": "object",
        "properties": {
          "refined_tags": {
            "title": "Refined Tags",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RefinedTag"
            }
          },
          "total_count": {
            "title": "Total Count",
            "examples": [
              10,
              50
            ],
            "type": "integer"
          }
        },
        "required": [
          "refined_tags",
          "total_count"
        ],
        "additionalProperties": false
      },
      "RefinedTag": {
        "title": "RefinedTag",
        "type": "object",
        "properties": {
          "allow_automatic_rules": {
            "title": "Allow Automatic Rules",
            "description": "Specifies whether to allow automatic creation of rules",
            "examples": [
              true,
              false
            ],
            "type": "boolean"
          },
          "last_reviewed_at": {
            "title": "Last Reviewed At",
            "description": "The date of the last review",
            "examples": [
              "2024-03-06T16:05:19"
            ],
            "type": "string",
            "format": "date-time"
          },
          "last_reviewed_by": {
            "title": "Last Reviewed By",
            "description": "The user who last reviewed the refined tag",
            "examples": [
              "user@example.com"
            ],
            "type": "string"
          },
          "next_review_at": {
            "title": "Next Review At",
            "description": "The date of the next review",
            "examples": [
              "2024-04-06T16:05:19"
            ],
            "type": "string",
            "format": "date-time"
          },
          "tag_name": {
            "title": "Tag Name",
            "examples": [
              "color",
              "size"
            ],
            "type": "string"
          },
          "tag_value": {
            "title": "Tag Value",
            "examples": [
              "red",
              "large"
            ],
            "type": "string"
          },
          "boost_rules": {
            "title": "Boost Rules",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BoostRuleResponse"
            }
          },
          "blacklist_rules": {
            "title": "Blacklist Rules",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BlacklistRuleResponse"
            }
          },
          "whitelist_rule": {
            "$ref": "#/components/schemas/WhitelistRuleResponse"
          }
        },
        "required": [
          "tag_name",
          "tag_value",
          "boost_rules",
          "blacklist_rules"
        ],
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "http_basic_auth": {
        "type": "http",
        "scheme": "basic"
      },
      "http_bearer_auth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false
  }
}
```