The Search API provides options for controlling what additional attributes are included in the response.
- Allows clients to request one or more custom attributes defined for articles.
- Pass as a comma-separated list of attribute names in the query.
- Useful for enriching responses with metadata beyond the default schema.
- Default: none (custom attributes are not returned unless explicitly requested).
- Example: Request region and complianceLevel as additional attributes:
curl -X GET \ "https://<API_DOMAIN>/knowledge/portalmgr/v4/PROD-1000/search?q=mortgage%20rates&articleCustomAdditionalAttributes=region,complianceLevel&$lang=en-US" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>"
A successful response includes the custom attributes in the customAttributes field:
{
"searchResults": {
"article": [
{
"id": "PROD-2001",
"name": "Current Mortgage Rates",
"snippet": "Today's mortgage rates are...",
"customAttributes": [
{
"name": "region",
"value": ["US-West"],
"type": "STRING"
},
{
"name": "complianceLevel",
"value": ["SOX"],
"type": "STRING"
}
]
}
]
}
}