---
title: "Search for businesses"
method: GET
path: "/business/search"
tags: ["Businesses"]
---

# Search for businesses

`GET /business/search`

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).

## Query parameters

- `query` string
- `business__in` BusinessId[]
- `code__in` BusinessCode[]
- `org_id` integer
- `groups` integer[]
- `country` string
- `name` string
- `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`.
- `zipcode` string
- `city` string
- `code` string
- `modified__gte` number
- `features__in` 'diffusion' | 'feedback_management' | 'messages' | 'posts' | 'review_invite' | 'review_management'
- `features__notin` 'diffusion' | 'feedback_management' | 'messages' | 'posts' | 'review_invite' | 'review_management'
- `subscribed_to_rm` boolean
- `subscribed_to_pm` boolean
- `subscribed_to_rb` boolean
- `subscribed_to_bm` boolean
- `completion_rate__gte` integer
- `completion_rate__lte` integer
- `completion_rate` 'low' | 'mid' | 'high'
- `has_promo` boolean
- `connected_to_gmb_location` boolean
- `connected_to_facebook_location` boolean
- `page` integer
- `per_page` integer
- `order_by` 'id' | 'name' | 'code' | 'created' | 'modified' | 'country' | 'city' | 'zipcode' | 'completion_rate' | '-id' | '-name' | '-code' | '-created' | '-modified' | '-country' | '-city' | '-zipcode' | '-completion_rate'

## Response `200`

OK

- object
  - `page` integer — Current page number
  - `max_page` integer — Last page number
  - `count` integer — Number of resources complying with filters
  - `businesses` BusinessWithCustomFields[] — List of Businesses
    - `id` string — Business id
    - `created` number, float — Timestamp (in seconds) of the business creation
    - `modified` number, float — Timestamp (in seconds) of the business last modification. 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` '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_date` string, 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_id` integer — Unique identifier of an organization in Partoo.
    - `groups` integer[] — List of Group ID of the business. Groups the business belongs to. See [the Groups and Sections description](/guides/api/resources/organizations/groups)
    - `name` string — The name of the business (POI) as it will appear on the publishing platforms
    - `address` string, 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_full` string, nullable — Full address of the business. For example : `130 Rue du Mont-Cenis`.
    - `address2` string, nullable — Complement of address. Any additional information that could help better find the business location
    - `city` string, nullable — The city where the business is located
    - `zipcode` string, nullable — Zipcode (or postal code) for the business address. Can be empty if the business' country does not require one.
    - `region` string, nullable — 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
    - `categories` string[] — A list of category ids mapped to the business. At least one category needs to be provided. For more information see [Categories section](/api-reference/categories/)
    - `time_slot_reference` TimeWindow[] — Default time period, can be used to set open hours of a day from Partoo's interface.
    - `open_hours` OpenHours — The opening hours of the business (in its timezone). Opening hours are specified per weekday. This is done by supplying an object mapping weekdays ("monday", "tuesday", etc.) to a list of strings. These strings in turn represent time slots during which the business is open. For example, the following value would set the opening hours to between 08:00-15:00 in the afternoon and 18:00-23:00 in the evening on Mondays: `{"monday": ["08:00-15:00", "18:00-23:00"]}` To indicate that a business is open 24 hours for a specific weekday, use the value `["00:00-23:59"]`. ❗ This field is not mandatory, but if not provided then the business will not be pushed on some platforms (example: Google). If provided, then a schedule needs to be sent for each day in particular.
      - `monday` TimeWindow[], required — Open in the morning and in the evening `[10:00-14:00, 18:00-00:00]`. Closed the whole day `[]`
      - `tuesday` TimeWindow[], required — Open in the morning and in the evening `[10:00-14:00, 18:00-00:00]`. Closed the whole day `[]`
      - `wednesday` TimeWindow[], required — Open in the morning and in the evening `[10:00-14:00, 18:00-00:00]`. Closed the whole day `[]`
      - `thursday` TimeWindow[], required — Open in the morning and in the evening `[10:00-14:00, 18:00-00:00]`. Closed the whole day `[]`
      - `friday` TimeWindow[], required — Open in the morning and in the evening `[10:00-14:00, 18:00-00:00]`. Closed the whole day `[]`
      - `saturday` TimeWindow[], required — Open in the morning and in the evening `[10:00-14:00, 18:00-00:00]`. Closed the whole day `[]`
      - `sunday` TimeWindow[], required — Open in the morning and in the evening `[10:00-14:00, 18:00-00:00]`. Closed the whole day `[]`
    - `specific_hours` SpecificHours — Exceptional opening or closing times for the business (in its timezone). All exceptional days of the year, including temporarily closed, can be specified beforehand or on the go. For example: - Beforehand: bank holidays (like Christmas or Labor Day) - Unpredicted: COVID-19 exceptional situation Specific hours are defined by two values: - `open`, containing a list of days with exceptional *opening* hours - `close`, containing a list of days where the business is exceptionally closed all day These values in turn contain: - `starts_at` indicating the first date for which the exceptional hours are valid - `ends_at` indicating the last date (inclusive) for which the exceptional hours are valid - `open_hours` (only used for days with exceptional *opening* hours) indicating the actual time slots for the given period, following the same pattern as the time slots in `open_hours`
      - `open` object[], required
        - `starts_at` string
        - `ends_at` string
        - `open_hours` TimeWindow[]
      - `close` object[], required
        - `starts_at` string
        - `ends_at` string
    - `description_short` string — A short description of the business. ⚠️ It is limited to 80 characters
    - `description_long` string — A more detailed description of the business. ⚠️ It is limited to 750 characters
    - `website_url` string, uri — The business own website url or the main url of the company.
    - `facebook_url` string, uri — Business Facebook page url
    - `twitter_url` string, uri — Business twitter page url
    - `google_location_id` string — Id of Google Location to which the business is linked
    - `facebook_page_id` string — Id of Facebook Location to which the business is linked
    - `national_identification_number` string — 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_url` string, uri — Business LOGO URL
    - `contacts` Contact[] — Specify how the clients can reach the persons in charge of the business in case they have questions.
      - `name` string — Contact full name
      - `email` string, email — Contact email
      - `phone_numbers` string[] — Contact phone numbers - Preferably in the format E.164 ('+33302060628' instead of '0302060628')
      - `fax` string — Contact fax
    - `photos` Photos — Business photos Each business can have one or more photos associated
      - `LOGO` string, uri — 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` string, uri — The business's main photo URL. On Google, for example, it represents the cover photo on the top of the profile.
      - `secondary` string[] — Additional photos that can highlight the features of the business.
    - `lat` number, double, nullable — Latitude pushed on publishers. Decimals are separated by a dot and not by a comma.
    - `long` number, double, nullable — Longitude pushed on publishers. Decimals are separated by a dot and not by a comma.
    - `subscriptions` Subscriptions — Business product subscriptions. Deprecated, use `features` instead.
      - `presence_management` SubscriptionActive, required
        - `active` boolean, required — Product has been activated
      - `review_management` SubscriptionActive, required
        - `active` boolean, required — Product has been activated
      - `review_booster` SubscriptionActive, required
        - `active` boolean, required — Product has been activated
      - `messages` SubscriptionActive, required
        - `active` boolean, required — Product has been activated
    - `features` Feature[] — List of business' features.
    - `custom_fields` union[] — Custom Fields set for this Business They represent configurable fields that can be defined in addition to the normal business fields proposed by Partoo. They are unique to the organization and can be entirely adapted to the company's needs.
      - union
        - CustomFieldsFieldInteger — A Custom Field
          - `name` string — Name of the custom field
          - `type` string — Possible values are "BOOLEAN", "INTEGER", "TEXT", "FLOAT", "SINGLE_SELECT", "MULTIPLE_SELECT", "MULTIPLE_SELECT_IMAGE", "IMAGES_UPLOADER".
          - `id` integer — Id of the custom field
          - `order` integer
          - `value` integer, nullable — Value for this Custom Field. Can be NULL if not set.
        - CustomFieldsFieldNumber — A Custom Field
          - `name` string — Name of the custom field
          - `type` string — Possible values are "BOOLEAN", "INTEGER", "TEXT", "FLOAT", "SINGLE_SELECT", "MULTIPLE_SELECT", "MULTIPLE_SELECT_IMAGE", "IMAGES_UPLOADER".
          - `id` integer — Id of the custom field
          - `order` integer
          - `value` number, nullable — Value for this Custom Field. Can be NULL if not set.
        - CustomFieldsFieldText — A Custom Field
          - `name` string — Name of the custom field
          - `type` string — Possible values are "BOOLEAN", "INTEGER", "TEXT", "FLOAT", "SINGLE_SELECT", "MULTIPLE_SELECT", "MULTIPLE_SELECT_IMAGE", "IMAGES_UPLOADER".
          - `id` integer — Id of the custom field
          - `order` integer
          - `value` string, nullable — Value for this Custom Field. Can be NULL if not set.
        - CustomFieldsFieldBoolean — A Custom Field
          - `name` string — Name of the custom field
          - `type` string — Possible values are "BOOLEAN", "INTEGER", "TEXT", "FLOAT", "SINGLE_SELECT", "MULTIPLE_SELECT", "MULTIPLE_SELECT_IMAGE", "IMAGES_UPLOADER".
          - `id` integer — Id of the custom field
          - `order` integer
          - `value` boolean, nullable — Value for this Custom Field. Can be NULL if not set.
        - CustomFieldsFieldMultiSelect — A Custom Field
          - `name` string — Name of the custom field
          - `type` string — Possible values are "BOOLEAN", "INTEGER", "TEXT", "FLOAT", "SINGLE_SELECT", "MULTIPLE_SELECT", "MULTIPLE_SELECT_IMAGE", "IMAGES_UPLOADER".
          - `id` integer — Id of the custom field
          - `order` integer
          - `value` string[] — Value for this Custom Field. Can be NULL if not set.
        - CustomFieldsFieldMultiSelectImage — A Custom Field
          - `name` string — Name of the custom field
          - `type` string — Possible values are "BOOLEAN", "INTEGER", "TEXT", "FLOAT", "SINGLE_SELECT", "MULTIPLE_SELECT", "MULTIPLE_SELECT_IMAGE", "IMAGES_UPLOADER".
          - `id` integer — Id of the custom field
          - `order` integer
          - `value` string[] — Value for this Custom Field. Can be NULL if not set.
        - CustomFieldsFieldSingleSelect — A Custom Field
          - `name` string — Name of the custom field
          - `type` string — Possible values are "BOOLEAN", "INTEGER", "TEXT", "FLOAT", "SINGLE_SELECT", "MULTIPLE_SELECT", "MULTIPLE_SELECT_IMAGE", "IMAGES_UPLOADER".
          - `id` integer — Id of the custom field
          - `order` integer
          - `value` string, nullable — Value for this Custom Field. Can be NULL if not set.
        - CustomFieldsFieldImagesUploader — A Custom Field
          - `name` string — Name of the custom field
          - `type` string — Possible values are "BOOLEAN", "INTEGER", "TEXT", "FLOAT", "SINGLE_SELECT", "MULTIPLE_SELECT", "MULTIPLE_SELECT_IMAGE", "IMAGES_UPLOADER".
          - `id` integer — Id of the custom field
          - `order` integer
          - `value` CustomFieldValuesImagesUploader[] — Value for this Custom Field. Can be NULL if not set.
            - `text_field` string
            - `max_length` number
    - `completion_rate` integer — 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.
    - `promos` Promo[]
      - `title` string, required — Promo title
      - `description` string, required — Promo description
      - `term_of_use` string — Promo term of use
      - `additional_informations` string — Promo additional informations
      - `begin` number, required — Promo start timestamp
      - `end` number, required — Promo end timestamp
      - `images` string[] — Promo images to be displayed
      - `client_offer_url` string, uri — Promo URL
      - `promo_url` string, uri — URL of the website

## Other responses

- `400` — Your request is incorrect
- `401` — You are not authenticated

---

[API](https://skmtc.net/partoo/apis/partoo-rest-api.md) · [All operations](https://skmtc.net/partoo/apis/partoo-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/partoo/partoo-rest-api/revisions/3652d8b1a8b3/schema)