---
title: Get Filter
slug: get-filter
docTags: 
createdAt: 2026-08-25T19:28:59.170Z
---

{
  "id": "q_hXdyPI3wcL7DwI0V2LV",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.nue.io/metadata/filters/{objectApiName}/{id}",
    "servers": [
      {
        "url": "https://api.nue.io/metadata/filters/{objectApiName}/{id}",
        "description": "Nue Production API Endpoint"
      },
      {
        "url": "https://api.sandbox.nue.io/metadata/filters/{objectApiName}/{id}",
        "description": "Nue Sandbox API Endpoint"
      }
    ],
    "name": "Get Filter",
    "description": "Retrieve a specific filter definition by providing the object API name and filter ID.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "objectApiName",
          "type": "string",
          "description": "The object name."
        },
        {
          "kind": "required",
          "name": "id",
          "type": "string",
          "description": "The filter ID."
        }
      ],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "apiKeyAuth",
          "name": "nue-api-key",
          "kind": "optional",
          "type": "apiKey",
          "in": "header"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "FilterMetadataVO",
            "schema": [
              {
                "name": "conditions",
                "kind": "optional",
                "type": "array",
                "description": "",
                "example": "",
                "itemType": "object",
                "customType": "object[]",
                "itemExample": "",
                "itemDefault": ""
              },
              {
                "name": "name",
                "kind": "optional",
                "type": "string",
                "description": ""
              },
              {
                "name": "id",
                "kind": "optional",
                "type": "string",
                "description": ""
              }
            ],
            "modelRef": "#/components/schemas/FilterMetadataVO",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "SA06IL6skpjjBxxTaCDmc",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.nue.io/metadata/filters/{objectApiName}/{id} \\\n     --header 'accept: application/json'"
        },
        {
          "id": "t7dvyYroJ9bFBCphT2iMK",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/metadata/filters/{objectApiName}/{id}\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "X4P987kUTeZyFRL1vEx2P",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/metadata/filters/{objectApiName}/{id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "9JhuaTm6JcnhZatpeovXe",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/metadata/filters/{objectApiName}/{id}\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "SA06IL6skpjjBxxTaCDmc"
    },
    "results": {
      "languages": [
        {
          "id": "eh2svDPqK_8TVR3--OFvM",
          "language": "200",
          "code": "// OK\n{\n  \"conditions\": [\n    {}\n  ],\n  \"name\": \"\",\n  \"id\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "eh2svDPqK_8TVR3--OFvM"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}