Get the details of a business by id
GET/api/v2/businesses/:business_id
Get the details of a business by id
Request
Path Parameters
Responses
- 200
- 400
- 401
- 403
- 404
This endpoint lets you retrieve the data of a specific business.
- application/json
- Schema
- Example (from schema)
Schema
Timestamp (in seconds) of the business creation
Timestamp (in seconds) of the business last modification. It doesn't take into account changes to the Custom Fields or related objects.
Default value: open
The business own website url or the main url of the company.
Business Facebook page url
Business twitter page url
Business LOGO URL
Latitude pushed on publishers. Decimals are separated by a dot and not by a comma.
Longitude pushed on publishers. Decimals are separated by a dot and not by a comma.
Business id
@description The unique store code of the business. If not provided, it will be automatically generated
The organisation unique identifier. During onboarding, we create an organisation where all your businesses will be aggregated
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.
The name of the business (POI) as it will appear on the publishing platforms
Complement of address. Any additional information that could help better find the business location
The city where the business is located
Zipcode (or postal code) for the business address. Can be empty if the business' country does not require one.
The region where the business is located. Can be empty, it is only useful for some countries like Italy or Spain among others.
Business country - In the ISO 3166 alpha2 code format (i.e. use “FR” for France instead of "fr")
Business default language - it either corresponds to the country's default language or set as English by default
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
å A list of category ids mapped to the business. At least one category needs to be provided.
Id of GMB Location to which the business is linked
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>
Id of Facebook Location to which the business is linked
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
photos
object
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.
The business's main photo URL. On Google, for example, it represents the cover photo on the top of the profile.
Additional photos that can highlight the features of the business.
Photos of the businesses entire menu.
{
"created": 1409925979.5,
"modified": 1561335111.681374,
"status": "open",
"website_url": "https://www.corner-shop.co/",
"facebook_url": "https://www.facebook.com/the-corner-shop",
"twitter_url": "https://www.twitter.com/the-corner-shop",
"logo_url": "string",
"lat": -3.585993,
"long": 47.870341,
"id": "5409c35a97bbc544d8e26737",
"code": "CS-75019",
"org_id": 42,
"group_id": 23,
"name": "string",
"address_full": "string",
"address2": "string",
"city": "Paris",
"zipcode": "75019",
"region": "Ile-de-France",
"country": "FR",
"default_lang": "fr",
"description_short": "string",
"description_long": "string",
"categories": [
"gcid:restaurant"
],
"google_location_id": "string",
"google_place_id": "ChIJNxGL4jNt5kcRJKZ-n5fwmDQ",
"facebook_page_id": "string",
"national_identification_number": "string",
"photos": {
"LOGO": "string",
"primary": "string",
"secondary": [
"string"
],
"MENU": [
"string"
]
}
}