{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Response Customization","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"response-customization","__idx":0},"children":["Response Customization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Search API provides options for controlling what additional attributes are included in the response."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response-customization-1","__idx":1},"children":["Response Customization"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"custom-attributes--articlecustomadditionalattributes-","__idx":2},"children":["Custom Attributes (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["articleCustomAdditionalAttributes"]},")"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Allows clients to request one or more custom attributes defined for articles."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Pass as a comma-separated list of attribute names in the query."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Useful for enriching responses with metadata beyond the default schema."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Default: none (custom attributes are not returned unless explicitly requested)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Example: Request region and complianceLevel as additional attributes:",{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"curl","header":{"controls":{"copy":{}}},"source":"curl -X GET \\\n  \"https://<API_DOMAIN>/knowledge/portalmgr/v4/PROD-1000/search?q=mortgage%20rates&articleCustomAdditionalAttributes=region,complianceLevel&$lang=en-US\" \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer <YOUR_ACCESS_TOKEN>\"\n","lang":"curl"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A successful response includes the custom attributes in the customAttributes field:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"searchResults\": {\n    \"article\": [\n      {\n        \"id\": \"PROD-2001\",\n        \"name\": \"Current Mortgage Rates\",\n        \"snippet\": \"Today's mortgage rates are...\",\n        \"customAttributes\": [\n          {\n            \"name\": \"region\",\n            \"value\": [\"US-West\"],\n            \"type\": \"STRING\"\n          },\n          {\n            \"name\": \"complianceLevel\",\n            \"value\": [\"SOX\"],\n            \"type\": \"STRING\"\n          }\n        ]\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"Response Customization","id":"response-customization","depth":1},{"value":"Response Customization","id":"response-customization-1","depth":2},{"value":"Custom Attributes ( articleCustomAdditionalAttributes )","id":"custom-attributes--articlecustomadditionalattributes-","depth":3}],"frontmatter":{"seo":{"title":"Response Customization"}},"lastModified":"2026-02-01T01:28:51.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/developer-portal/guides/search/search_response_customization","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}