Skip to content
English
Go to brandwizard.io
  • There are no suggestions because the search field is empty.

Catalog API

In this documentation, you can find the description of the BrandWizard API method in the Catalog section.

 

 

Method GET/public/v1/catalogs/

  • Description: Retrieve a list of catalog objects.

  • Request Parameters:

    Parameter Type Required? Description
    ability_to_reply
    boolean
    		 No Ability to reply in the catalog
    brand_ids
    array[string]
    		 No List of brand IDs
    can_collect_reviews
    		 boolean No Catalogs with the ability to collect reviews
    city_ids array[string] No List of city IDs
    company_ids
    		 array[string] No List of company IDs
    has_review boolean No Catalogs with reviews
    is_external_reviews
    		 boolean No Supports external reviews
    related boolean No Related catalogs
    type string No Catalog type: 
    • map – Maps, Social networks, Catalogs 
    • navigator – Navigators
  • Response Fields: 
Field Type Description
id integer Catalog identifier
logo string Catalog logo
name string Catalog name
type string Catalog type: 
• map – Maps, Social networks, Catalogs 
• navigator – Navigators
icon string Catalog icon
content_short string Short description of the catalog
content string Full description of the catalog
traffic integer Data processed by the site from all sources over a specific period. Entered manually based on site data
weight integer Catalog weight – value used to sort catalogs when displaying aggregated company data across all catalogs
website string Link to the catalog's website