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

Company API

Contents:

In this documentation, you can find a description of the methods of the BrandWizard API section Company.

 

 

Method GET/public/v1/companies/

  • Description: Get a list of company objects.
  • Request parameters:
Parameter Type Required? Description
active
boolean
 No Active companies: Yes/No
brand_ids
 array[integer] No List of brand IDs
catalog_ids array[integer] No List of catalog IDs
city_ids array[integer] No List of city IDs
closed boolean No Closed companies: Yes/No
code array[string] No List of branch codes
company_group_ids
 array[integer] No List of company group IDs
company_ids array[integer] No List of company IDs
count integer No Number of results for paginated return
ids array[string] No Company IDs
is_active boolean No Company is active, does not require moderation, and is not closed: Yes/No
need_action boolean No CCL (company–catalog link) status "action required": Yes/No
page integer No Page number within the pagination result set
q string No Search string
  • Response fields:
Field Type Description
count integer Number of results
next string Link to the next page
previous string Link to the previous page
results id integer Company ID
code string Company code
name string Company name
address country string Country where the company is located
country_code string Country code
region string Region
city string City
street string Street
housenumber string House number
postcode string Postal code
description string Additional information about the company's location
string_address string Full company address
lat number Latitude coordinates
lon number Longitude coordinates
closed boolean Company closed: Yes/No
expired string License expiration date
payment_plan id integer Tariff plan ID
name string Tariff plan name
brand integer Brand name

 

 

Method GET/public/v1/companies/{company_id}/gallery/

  • Description: Get a list of company galleries.
  • Request parameters:
Parameter Type Required? Description
company_id
 string Yes Company ID

  • Response fields:

    Field Type Description
    id integer

    Gallery image ID
    image string Image

 

 

Method GET/public/v1/companies/{company_id}/gallery/{id}/

  • Description: Get the company gallery.
  • Request parameters:
Parameter Type Required? Description
company_id
 string Yes Company ID
id string Yes Gallery image ID
  • Response fields:
Field Type Description
id integer

Gallery image ID
image string Photo link

 

 

Method GET/public/v1/companies/{company_id}/images/{id}/

  • Description: Get a list of images by unique company ID.
  • Request parameters:
Parameter Type Required? Description
company_id
 string Yes Company ID
id integer Yes Logo and cover ID
  • Response fields:
Field Type Description
image_logo string List of company logo images
image_cover string List of company cover images

 

 

Method GET/public/v1/companies/{id}/

  • Description: Get a company object by its unique identifier.
  • Request parameters:
Parameter Type Required? Description
id
 integer Yes Company ID
  • Response fields:
Field Type Description
id integer Company ID
name string Company name
name_for_push string Company name sent to catalog
code string Branch code
brand id integer Brand ID
name string Brand name
alt_names string Alternative names
legal ogrn string Primary State Registration Number (for Russia)
inn string Taxpayer Identification Number (INN) (for Belarus)
form string Legal form
name string Legal name
categories id integer Category ID
name string Category name
is_main boolean Main category: Yes/No
created string Creation date
expired string License expiration date
is_payed boolean Paid: Yes/No
payment_plan id integer Tariff plan ID
name string Tariff plan name
description_short string Short description
description string Description
email string Email address
phones phone string Phone number
is_main boolean Main phone number: Yes/No
website string Website link
socials url string Social network link
  name string Social network name
logo string Logo
icon string Icon
work_time 1 start string Workday start time
end string Workday end time
breaks start string Break start time
end string Break end time
2 start string Workday start time
end string Workday end time
breaks start string Break start time
end string Break end time
3 start string Workday start time
end string Workday end time
breaks start string Break start time
end string Break end time
4 start string Workday start time
end string Workday end time
breaks start string Break start time
end string Break end time
5 start string Workday start time
end string Workday end time
breaks start string Break start time
end string Break end time
6 start string Workday start time
end string Workday end time
breaks start string Break start time
end string Break end time
7 start string Workday start time
end string Workday end time
breaks start string Break start time
end string Break end time
is_temporary_closed boolean Temporarily closed: Yes/No
special_hours start string Special schedule workday start time
end string Special schedule workday end time
breaks start string Special schedule break start time
end string Special schedule break end time
start_date   string Special schedule start date
end_date   string Special schedule end date
payment_methods id string Payment method ID
name string Payment method name
image_logo - Company logo image
image_cover - Company cover image
closed boolean Company closed: Yes/No
address country string Country where the company is located
country_code string Country code
region string Region
city string City
street string Street
housenumber string House number
postcode string Postal code
description string Additional information about company location
string_address string Full address
lat number Latitude coordinates
lon number Longitude coordinates
permissions string User permissions for the company

 

 

Method GET/public/v1/companies/{id}/rating_dynamic/

  • Description: Returns a dynamic rating for a specific company based on catalog IDs.
  • Request parameters:
Parameter Type Required? Description
catalog_ids
 string Yes

Catalog IDs, separated by commas, for rating filtering
id integer Yes Company ID

  • Response fields:

    Field Type Description
    month string Month
    date string Date
    total integer Total rating value
    sentiments negative integer Number of negative reviews
    positive integer Number of positive reviews
    neutral integer Number of neutral reviews
    unspecified integer Number of unspecified reviews

 

 

Method GET/public/v1/companies/legal_types/

  • Description: Get a list of organizational form types.
  • Request parameters: None.
  • Response fields: None.

 

 

Method GET/public/v1/companies/rating/

  • Description: Get ratings of companies from catalogs (Google Business Profile, Yandex Maps, 2GIS) for the last 24 hours.
  • Request parameters: 
Parameter Type Required? Description
active
boolean
 No Active companies: Yes/No
brand_ids
 array[integer] No List of brand IDs
catalog_ids array[integer] No List of catalog IDs
city_ids array[integer] No List of city IDs
closed boolean No Closed companies: Yes/No
code array[string] No List of branch codes
company_group_ids
 array[integer] No List of company group IDs
company_ids array[integer] No List of company IDs
count integer No Number of results for paginated return
ids array[string] No Company IDs
is_active boolean No Company is active, does not require moderation, and is not closed: Yes/No
need_action boolean No CCL (company–catalog link) status "action required": Yes/No
page integer No Page number within the pagination result set
q string No Search string
  • Response fields: None.