Sign in

v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB
Businesses

Search for businesses

This lets you search among the businesses you have READ access to. You can use several filters. The response is paginated (30 results per page).

get/business/search

Query parameters

querystring

Parameter to fuzzy search businesses on city, zipcode and name

business__inBusinessId[]

Filter by business ids. Use a comma-separated list to provide multiple ids.

[
  "5409c35a97bbc544d8e26737"
]
code__inBusinessCode[]

Filter by business code. Use a comma-separated list to provide multiple codes.

[
  "CS-75019"
]
org_idinteger

Filter by organization ID. Only PROVIDER users can use this filter. If you are not a PROVIDER, this will default to the ID of your organization.

groupsinteger[]

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

See the Groups and Sections description

countrystring

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

namestring

Filter by name

status'open' | 'closed' | 'opening_soon' | '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.
  • 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.

Example:open
zipcodestring

Filter by zipcode

citystring

Filter by city

codestring

Filter by code

modified__gtenumber

Filter by modified attribute (modified >= modified_gte)

features__in'diffusion' | 'feedback_management' | 'messages' | 'posts' | 'review_invite' | 'review_management'
features__notin'diffusion' | 'feedback_management' | 'messages' | 'posts' | 'review_invite' | 'review_management'
subscribed_to_rmboolean

Filter by current subscription to review_management.

  • If true, only businesses subscribed to review_management will be included.
  • If false, only businesses not subscribed to review_management will be included.

Equivalent to using features__in=review_management.

subscribed_to_pmboolean

Filter by current subscription to presence_management.

  • If true, only businesses subscribed to presence_management will be included.
  • If false, only businesses not subscribed to presence_management will be included.

Equivalent to using features__in=diffusion.

subscribed_to_rbboolean

Filter by current subscription to review_booster.

  • If true, only businesses subscribed to review_booster will be included.
  • If false, only businesses not subscribed to review_booster will be included.

Equivalent to using features__in=review_invite.

subscribed_to_bmboolean

Filter by current subscription to messages.

  • If true, only businesses subscribed to messages will be included.
  • If false, only businesses not subscribed to messages will be included.

Equivalent to using features__in=messages.

completion_rate__gteinteger

Filter by completion_rate attribute (completion_rate >= completion_rate__gte)

completion_rate__lteinteger

Filter by completion_rate attribute (completion_rate <= completion_rate__lte)

completion_rate'low' | 'mid' | 'high'
Example:low,mid

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

has_promoboolean
  • If true, include only businesses having promotional offers.
  • If false, include only businesses not having any promotional offer.
connected_to_gmb_locationboolean
  • If true, only businesses currently linked to a Google location will be included.
  • If false, only businesses not linked to any Google location will be included.
connected_to_facebook_locationboolean
  • If true, only businesses currently linked to a Facebook location will be included.
  • If false, only businesses not linked to any Facebook location will be included.
pageinteger

Page number. Starts at 1. Any value lower than 1 will be considered as 1. For the number of items per page, see the per_page query parameter.

per_pageinteger

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

order_by'id' | 'name' | 'code' | 'created' | 'modified' | 'country' | 'city' | 'zipcode' | 'completion_rate' | '-id' | '-name' | '-code' | '-created' | '-modified' | '-country' | '-city' | '-zipcode' | '-completion_rate'

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

Response

OK

pageinteger

Current page number

max_pageinteger

Last page number

countinteger

Number of resources complying with filters

Example response

{
  "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,
      "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
    }
  ]
}