Sign in

v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB
Businesses

Business information

This endpoint lets you access to the information of a business. You need to have READaccess on this business.

get/business/{business_id}

Path parameters

business_idstring required

Business id.

It may be replaced by c-{code} where code is the store code, which should be unique per organization. This can be used only for ORG_ADMIN, GROUP_MANAGER and BUSINESS_MANAGER users.

Response

OK

idstring

Business id

creatednumber float

Timestamp (in seconds) of the business creation

modifiednumber float

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

codestring

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

status'open' | 'closed' | 'closed_temporarily'

Defines the current status of the business. open indicates the business is up and running. closed means that the business has definitely closed. closed_temporarily means that the business is temporarily closed, it is advised when your business is closed for more than one week, otherwise use the specific_hours

opening_datestring YYYY-MM-DD

The opening_date represents the date when a business was opened. The format of the date must be in ISO 8601 format (YYYY-MM-DD). ⚠️ The date must be in the past or no more than one year in the future from the current date (Google API requirement).

org_idinteger

Unique identifier of an organization in Partoo.

groupsinteger[]

List of Group ID of the business.

Groups the business belongs to.

See the Groups and Sections description

namestring

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

addressstring nullable

Business address. This fields returns the same value as the field address_full for historical reasons. You should prefer the use address_full.

address_fullstring nullable

Full address of the business.

For example : 130 Rue du Mont-Cenis.

address2string nullable

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

citystring nullable

The city where the business is located

zipcodestring nullable

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

regionstring nullable

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

countrystring

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

default_langstring

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

categoriesstring[]

A list of category ids mapped to the business. At least one category needs to be provided. For more information see Categories section

time_slot_referenceTimeWindow[]

Default time period, can be used to set open hours of a day from Partoo's interface.

description_shortstring

A short description of the business.

⚠️ It is limited to 80 characters

description_longstring

A more detailed description of the business.

⚠️ It is limited to 750 characters

website_urlstring uri

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

facebook_urlstring uri

Business Facebook page url

twitter_urlstring uri

Business twitter page url

google_location_idstring

Id of Google Location to which the business is linked

facebook_page_idstring

Id of Facebook Location to which the business is linked

national_identification_numberstring

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 the SIRET code, or for Ireland, it's the CRO.

logo_urlstring uri

Business LOGO URL

latnumber double nullable

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

longnumber double nullable

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

featuresFeature[]

List of business' features.

completion_rateinteger

The completion rate percentage of the business.

The completion rate is calculated based on how many fields are filled for the business.
If some necessary fields are not filled, it will lower the completion rate.

⚠️ After the update of the business, it may take up to 24 hours for this field to be updated.

Example response

{
  "id": "5409c35a97bbc544d8e26737",
  "created": 1409925979.5,
  "modified": 1561335111.681374,
  "code": "CS-75019",
  "status": "open",
  "opening_date": "2025-01-01",
  "org_id": 42,
  "groups": [
    1,
    2,
    3
  ],
  "name": "Corner shop",
  "address_full": "12 bis rue du coquelicot",
  "city": "Paris",
  "zipcode": "75019",
  "region": "Ile-de-France",
  "country": "FR",
  "default_lang": "fr",
  "categories": [
    "gcid:restaurant",
    "gcid:fast_food_restaurant",
    "gcid:hamburger_restaurant"
  ],
  "time_slot_reference": [
    "10:00-14:00"
  ],
  "open_hours": {
    "monday": [
      "10:00-14:00"
    ],
    "tuesday": [
      "10:00-14:00"
    ],
    "wednesday": [
      "10:00-14:00"
    ],
    "thursday": [
      "10:00-14:00"
    ],
    "friday": [
      "10:00-14:00"
    ],
    "saturday": [
      "10:00-14:00"
    ],
    "sunday": [
      "10:00-14:00"
    ]
  },
  "specific_hours": {
    "open": [
      {
        "starts_at": "2020-01-20",
        "ends_at": "2020-01-20",
        "open_hours": [
          "10:00-14:00"
        ]
      }
    ],
    "close": [
      {
        "starts_at": "2020-01-20",
        "ends_at": "2020-01-22"
      }
    ]
  },
  "description_short": "lorem ipsum",
  "description_long": "lorem ipsum dolor sit amet",
  "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",
  "contacts": [
    {
      "name": "Hubert Bonisseur de la Bath",
      "email": "hubert@oss117.fr",
      "phone_numbers": [
        "+33302060628"
      ],
      "fax": "+33302060629"
    }
  ],
  "lat": -3.585993,
  "long": 47.870341,
  "subscriptions": {
    "presence_management": {
      "active": true
    },
    "review_management": {
      "active": true
    },
    "review_booster": {
      "active": false
    },
    "messages": {
      "active": false
    }
  },
  "features": [
    "business_edition",
    "diffusion",
    "review_management",
    "review_invite",
    "messages"
  ],
  "custom_fields": [
    {
      "id": 1,
      "type": "BOOLEAN",
      "name": "Parking",
      "value": true,
      "order": 1
    },
    {
      "id": 2,
      "type": "TEXT",
      "name": "ManagerName",
      "value": "toto",
      "order": 2
    },
    {
      "id": 3,
      "type": "TEXT",
      "name": "Supervisor",
      "value": null,
      "order": 2
    },
    {
      "id": 4,
      "type": "INTEGER",
      "name": "Surface",
      "value": 2,
      "order": 3
    },
    {
      "id": 5,
      "type": "FLOAT",
      "name": "DistanceFromSubway",
      "value": 2.55,
      "order": 4
    },
    {
      "id": 6,
      "type": "SINGLE_SELECT",
      "name": "Level",
      "value": "two",
      "order": 4
    },
    {
      "id": 7,
      "type": "MULTIPLE_SELECT",
      "name": "Services",
      "value": [
        "one",
        "two"
      ],
      "order": 5
    },
    {
      "id": 8,
      "type": "MULTIPLE_SELECT_IMAGE",
      "name": "BannerImage",
      "value": [
        "image 1",
        "image 2"
      ],
      "order": 6
    },
    {
      "id": 9,
      "type": "IMAGES_UPLOADER",
      "name": "TeamMembers",
      "value": [
        {
          "url": "image1",
          "texts": {
            "name1": "value 1",
            "name2": "value 2"
          }
        }
      ],
      "order": 7
    }
  ],
  "completion_rate": 77
}