Documentation Knowledgebase

This area helps us show you how to use our features to grow your business.

OpenContent Helper

Use the Business Directory API

Use the public OpenContent Helper business directory endpoints to load categories for a Select2-style picker, find businesses by selected category IDs, and generate the public company sitemap as XML for the current portal.

Updated

The business-directory endpoints are public, read-only, and scoped to the current portal. The base URL is /DesktopModules/OpenContentHelper/API.

Load categories for a picker

Use either request style:

  • GET /BusinessDirectoryLookup/LookupCategories?term=food&page=1
  • GET /BusinessDirectoryLookup/LookupCategories?q=food&page=1
  • POST /BusinessDirectoryLookup/LookupCategories with a category lookup request body

The returned id, text, and value fields use the category name because OpenContent category fields save category names, not numeric IDs. The response also includes category ID and slug metadata.

Find businesses by category

Call:

POST /BusinessDirectoryLookup/GetBusinessesByCategories

Send the selected category IDs and the requested page size in the request body. The response includes the total count and the matching business items.

Create the public company sitemap

Call:

GET /BusinessDirectorySitemap/Sitemap

The response is XML. Records without a valid public route or canonical URL are excluded. If the site or result set exceeds the safe sitemap limits, the endpoint returns a temporary-unavailable response instead of producing an unsafe or incomplete sitemap.

Topics: