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

# /getValuesByProfileKey

Returns Key/Value pairs of a specific Keyword profile based on the 'profile-key' provided

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Agilit-e Keywords",
    "version": "7"
  },
  "servers": [
    {
      "url": "https://api.agilite.io/keywords"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "api-key"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/getValuesByProfileKey": {
      "get": {
        "summary": "/getValuesByProfileKey",
        "description": "Returns Key/Value pairs of a specific Keyword profile based on the 'profile-key' provided",
        "operationId": "getbyprofilekey",
        "parameters": [
          {
            "name": "profile-key",
            "in": "header",
            "description": "Unique Key for the targeted profile",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "header",
            "description": "An optional parameter to sort the return Key/Value result (asc/desc/asc_value/desc_value)",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "output-format",
            "in": "header",
            "description": "An optional parameter to format the output of the returned result (array/json)",
            "schema": {
              "type": "string",
              "default": "array"
            }
          },
          {
            "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    {\n        \"label\": \"label1\",\n        \"value\": \"value1\"\n    },\n    {\n        \"label\": \"label2\",\n        \"value\": \"value2\"\n    },\n    {\n        \"label\": \"label3\",\n        \"value\": \"value3\"\n    }\n]"
                  }
                },
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "label": {
                        "type": "string",
                        "example": "label1"
                      },
                      "value": {
                        "type": "string",
                        "example": "value1"
                      }
                    }
                  }
                }
              }
            }
          },
          "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": "5fc0c5ba525f16005dcefb91:5fc0c5ba525f16005dcefbc0"
}
```