---
agentTools:
  projectIndex: https://docs.agilite.io/llms.txt
---

# /getTierByKey

Returns Tier Structure Profiles based on Tier Keys

Note: The `tierEntries` Array will contain the nested Tiers relevant to the Tier Key specified

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Agilit-e Tier Structures",
    "version": "7"
  },
  "servers": [
    {
      "url": "https://api.agilite.io/tierstructures"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "api-key"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/getTierByKey": {
      "get": {
        "summary": "/getTierByKey",
        "description": "Returns Tier Structure Profiles based on Tier Keys",
        "operationId": "gettierbykey",
        "parameters": [
          {
            "name": "tier-keys",
            "in": "header",
            "description": "Returns Tiers based on Tier Keys (comma separated)",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "include-values",
            "in": "header",
            "description": "Include Value Arrays",
            "schema": {
              "type": "boolean",
              "default": true
            }
          },
          {
            "name": "include-meta-data",
            "in": "header",
            "description": "Include Meta Data",
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "include-tier-entries",
            "in": "header",
            "description": "Include Tier Entries",
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "sort-values",
            "in": "header",
            "description": "Ascending (asc) or Descending (desc)",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "values-output-format",
            "in": "header",
            "description": "array / json / string",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "log-profile-key",
            "in": "header",
            "description": "Profile Key of the Batch Logging Profile configured for logging",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"values\": [\n        {\n            \"label\": \"label\",\n            \"value\": \"value\"\n        }\n    ],\n    \"tierEntries\": [\n        {\n            \"_id\": \"\",\n            \"isActive\": true,\n            \"key\": \"tier_entry_1\",\n            \"description\": \"description\",\n            \"notes\": \"notes\",\n            \"values\": [\n                {\n                    \"label\": \"label\",\n                    \"value\": \"value\"\n                }\n            ],\n            \"tierEntries\": []\n        }\n    ],\n    \"isActive\": true,\n    \"key\": \"tier1\",\n    \"description\": \"description\",\n    \"notes\": \"notes\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "values": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "label": {
                            "type": "string",
                            "example": "label"
                          },
                          "value": {
                            "type": "string",
                            "example": "value"
                          }
                        }
                      }
                    },
                    "tierEntries": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "_id": {
                            "type": "string",
                            "example": ""
                          },
                          "isActive": {
                            "type": "boolean",
                            "example": true,
                            "default": true
                          },
                          "key": {
                            "type": "string",
                            "example": "tier_entry_1"
                          },
                          "description": {
                            "type": "string",
                            "example": "description"
                          },
                          "notes": {
                            "type": "string",
                            "example": "notes"
                          },
                          "values": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "label": {
                                  "type": "string",
                                  "example": "label"
                                },
                                "value": {
                                  "type": "string",
                                  "example": "value"
                                }
                              }
                            }
                          },
                          "tierEntries": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {}
                            }
                          }
                        }
                      }
                    },
                    "isActive": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "key": {
                      "type": "string",
                      "example": "tier1"
                    },
                    "description": {
                      "type": "string",
                      "example": "description"
                    },
                    "notes": {
                      "type": "string",
                      "example": "notes"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"statusCode\": 400,\n    \"errorMessage\": \"An Error Occurred\",\n    \"additionalMessages\": [\"An Error Occured\"]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "statusCode": {
                      "type": "integer",
                      "example": 400,
                      "default": 0
                    },
                    "errorMessage": {
                      "type": "string",
                      "example": "An Error Occurred"
                    },
                    "additionalMessages": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "An Error Occured"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "5fc0c5ba525f16005dcefb9b:5fc0c5ba525f16005dcefc0b"
}
```