Skip to main content

Get the details of a business by id

GET 
/api/v2/businesses/:business_id

This endpoint lets you retrieve the data of a specific business.

Request​

Path Parameters

    business_id stringrequired

Responses​

Schema

    id stringrequired
    created number

    Timestamp (in seconds) of the business creation

    modified number

    Timestamp (in seconds) of the business last modification. It doesn't take into account changes to the Custom Fields or related objects.

    code string

    The unique store code of the business. If not provided, it will be automatically generated

    status string

    Possible values: [open, closed, temporarily_closed]

    Default value: open

    Defines the current status of the business. Open indicates the business is up and running. Closed means that the business has definitely closed. For temporarily closed businesses please use the specific_hours.

    org_id integer

    The organisation unique identifier. During onboarding, we create an organisation where all your businesses will be aggregated

    group_id integernullable

    The id of the group the business belongs to. An organisation can have multiple groups that contain one or more businesses. A business can belong to only one group.

    name string

    The name of the business (POI) as it will appear on the publishing platforms

    address_full string

    Full address of the business.

    For example : `130 Rue du Mont-Cenis

    address2 stringnullable

    Complement of address. Any additional information that could help better find the business location

    city string

    The city where the business is located

    zipcode string

    Zipcode (or postal code) for the business address. Can be empty if the business' country does not require one.

    region stringnullable

    The region where the business is located. Can be empty, it is only useful for some countries like Italy or Spain among others.

    country string

    Business country - In the ISO 3166 alpha2 code format (i.e. use “FR” for France instead of "fr")

    default_lang string

    Business default language - it either corresponds to the country's default language or set as English by default

    description_short stringnullable

    A short description of the business. It needs to be in the language of the country where the business is located. For example, if the business is located in Madrid, then the description needs to be in Spanish.

    ⚠️It is limited to 200 characters

    description_long stringnullable

    A more detailed description of the business. It needs to be in the language of the country where the business is located. For example, if the business is located in London, then the description needs to be in English.

    ⚠️It is limited to 750 characters

    categories string[]

    A list of category ids mapped to the business. At least one category needs to be provided.

    website_url urinullable

    The business own website url or the main url of the company.

    facebook_url urinullable

    Business Facebook page url

    twitter_url stringnullable

    Business twitter page url

    google_location_id string

    Id of GMB Location to which the business is linked

    google_place_id string

    Unique reference to the business on Google Maps and Google Places, can be used to construct a review URL for example, https://search.google.com/local/writereview?placeid=<google_place_id>

    facebook_page_id string

    Id of Facebook Location to which the business is linked

    national_identification_number stringnullable

    The National Identification Number of the business

    It describes a unique number for which the business is registered in a specific country. For example, in France, it's SIRET code or for Ireland it's the CRO

    logo_url urinullable

    Business LOGO URL

    photos

    object

    LOGO urinullable

    The logo image of the brand. On Google, for example, for businesses that have their basic information (phone number, hours, etc.), the Business Profile will highlight the logo.

    primary urinullable

    The business's main photo URL. On Google, for example, it represents the cover photo on the top of the profile.

    secondary uri[]required

    Additional photos that can highlight the features of the business.

    MENU uri[]required

    Photos of the businesses entire menu.

    lat number

    Latitude pushed on publishers. Decimals are separated by a dot and not by a comma.

    long number

    Longitude pushed on publishers. Decimals are separated by a dot and not by a comma.

    subscriptions

    object

    presence_management

    object

    required

    active booleanrequired

    Product has been activated

    review_management

    object

    required

    active booleanrequired

    Product has been activated

    review_booster

    object

    required

    active booleanrequired

    Product has been activated

    messages

    object

    required

    active booleanrequired

    Product has been activated

Loading...