Skip to main content
GET
/
business
/
search
Search for businesses
curl --request GET \
  --url https://api.partoo.co/v2/business/search \
  --header 'x-APIKey: <api-key>'
{
  "page": 1,
  "max_page": 10,
  "count": 287,
  "businesses": [
    {
      "id": "5409c35a97bbc544d8e26737",
      "created": 1409925979.5,
      "modified": 1561335111.681374,
      "code": "CS-75019",
      "status": "open",
      "opening_date": "2025-01-01",
      "org_id": 42,
      "group_id": 23,
      "groups": [
        1,
        2,
        3
      ],
      "name": "Corner shop",
      "address": "<string>",
      "address_full": "12 bis rue du coquelicot",
      "address2": "<string>",
      "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",
      "google_location_id": "<string>",
      "facebook_page_id": "<string>",
      "national_identification_number": "<string>",
      "logo_url": "<string>",
      "contacts": [
        {
          "name": "Hubert Bonisseur de la Bath",
          "email": "hubert@oss117.fr",
          "phone_numbers": [
            "+33302060628"
          ],
          "fax": "+33302060629"
        }
      ],
      "photos": {
        "LOGO": "<string>",
        "primary": "<string>",
        "secondary": [
          "<string>"
        ]
      },
      "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,
      "promos": [
        {
          "title": "<string>",
          "description": "<string>",
          "term_of_use": "<string>",
          "additional_informations": "<string>",
          "begin": 123,
          "end": 123,
          "images": [
            "<string>"
          ],
          "client_offer_url": "<string>",
          "promo_url": "<string>"
        }
      ]
    }
  ]
}

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Query Parameters

​
query
string

Parameter to fuzzy search businesses on city, zipcode and name

​
business__in
string[]

Filter by business ids

Business id

​
org_id
integer

Filter by organization id

​
groups
integer[]

Filter by groups, using the access logic with the and/or depending on the groups sections

See the Groups and Sections description

​
country
string

Filter by country - ISO 3166 alpha2 code (i.e. “FR” for France)

​
name
string

Filter by name

​
status
enum<string>
default:open

Defines the current status of the business.

  • Open indicates the business is up and running.
  • Closed means that the business has definitely closed.
  • Opening Soon indicates the business is open with an opening date set in the future.
  • Temporarily closed means that the business is temporarily closed.

⚠️ To get all businesses with the status open, regardless of whether the opening_date has passed yet or not, submit both the open and opening_soon options in the filter: status=open,opening_soon.

Available options:
open,
closed,
opening_soon,
temporarily_closed
Example:

"open"

​
zipcode
string

Filter by zipcode

​
city
string

Filter by city

​
code
string

Filter by code

​
modified__gte
number

Filter by modified attribute (modified >= modified_gte)

​
features__in
enum<string>

Filter businesses that have all the features provided, separated by commas.

Available options:
diffusion,
feedback_management,
messages,
posts,
review_invite,
review_management
Example:

"diffusion,review_management"

​
features__notin
enum<string>

Filter businesses that do not have all the features provided, separated by commas.

Available options:
diffusion,
feedback_management,
messages,
posts,
review_invite,
review_management
Example:

"diffusion,review_management"

​
subscribed_to_rm
enum<string>

Filter by current subscription to review_management. Equivalent to using features__in=review_management.

Available options:
True,
False
​
subscribed_to_pm
enum<string>

Filter by current subscription to presence_management. Equivalent to using features__in=diffusion.

Available options:
True,
False
​
subscribed_to_rb
enum<string>

Filter by current subscription to review_booster. Equivalent to using features__in=review_invite.

Available options:
True,
False
​
subscribed_to_bm
enum<string>

Filter by current subscription to messages Equivalent to using features__in=messages

Available options:
True,
False
​
completion_rate__gte
number

Filter by completion_rate attribute (completion_rate >= completion_rate__gte)

​
completion_rate__lte
number

Filter by completion_rate attribute (completion_rate <= completion_rate__lte)

​
completion_rate
enum<string>

Filter by completion_rate attribute. You can separate the values by a comma, as done in the example.

Available options:
low,
mid,
high
Example:

"low,mid"

​
has_promo
enum<string>
deprecated

Retrieve only businesses having promotional offers

Available options:
True,
False
​
connected_to_gmb_location
enum<string>

Filter by current link to a Google location

Available options:
True,
False
​
connected_to_facebook_location
enum<string>

Filter by current link to a Facebook location

Available options:
True,
False
​
page
integer
default:1

Page number, Starts at 1. From 1 to 100 results per page (see per_page)

​
per_page
integer
default:30

Number of items to return per page. Currently limited to 100.

Required range: 1 <= x <= 100
​
order_by
enum<string>
default:id

Order result by given attribute. Reverse order can as well be obtained by using a - (minus sign) before the attribute name, e.g. order_by=-name

Available options:
id,
name,
code,
created,
modified,
country,
city,
zipcode,
completion_rate,
-id,
-name,
-code,
-created,
-modified,
-country,
-city,
-zipcode,
-completion_rate

Response

OK

​
page
integer

Current page number

Example:

1

​
max_page
integer

Last page number

Example:

10

​
count
integer

Number of resources complying with filters

Example:

287

​
businesses
object[]

List of Businesses