---
title: "GET /api/v1.0/search/restaurants"
method: GET
path: "/api/v1.0/search/restaurants"
tags: ["Search"]
---

# GET /api/v1.0/search/restaurants

`GET /api/v1.0/search/restaurants`

## Request

- Base URL: `https://api.flipdish.co`
- URL: `https://api.flipdish.co/api/v1.0/search/restaurants`
- Auth: OAuth 2 (implicit, authorization URL `https://api.flipdish.co/identity/connect/authorize`, scopes: `api`)

## Query parameters

- `query` string, required
- `countryId` string, required
- `includeArchivedStores` 'NonArchivedOnly' | 'ArchivedOnly' | 'Both'
- `searchType` 'WhiteLabelConfigInfo' | 'WhiteLabelConfigVirtualRestaurantInfo' | 'WhiteLabelConfigPhysicalRestaurantInfo' | 'WhiteLabelConfigPhysicalRestaurantAddressInfo'
- `publishedStatus` 'AllStores' | 'Published' | 'Unpublished'
- `page` integer
- `limit` integer

## Response `200`

OK

- RestApiPaginationResultRestaurant: Rest api pagination result
  - `Page` integer, required: Current page index
  - `Limit` integer, required: Current page size
  - `TotalRecordCount` integer, required: Total record count
  - `Data` Restaurant[], required: Generic data object.
    - `WhiteLabelConfigs` WhiteLabelConfig[]: Collection of white label configurations
      - `WhiteLabelId` integer: White label identifier
      - `WhiteLabelName` string: White label name
      - `CountryId` string: Country identifier
      - `AppNameId` string: App id
      - `Website` string: Website URL
      - `PanaceaVanityUrl` string: Panacea vanity URL
    - `VirtualRestaurantId` integer: Virtual restaurant identifier
    - `VirtualRestaurantName` string: Virtual restaurant name
    - `VirtualRestaurantUrl` string: Virtual restaurant URL
    - `PhysicalRestaurantId` integer: Physical restaurant identifier
    - `PhysicalRestaurantName` string: Physical restaurant name
    - `PhysicalRestaurantAddress` string: Physical restaurant address
    - `MenuId` integer: Menu identifier
    - `IsArchived` boolean: Indicates if the restaurant is archived
    - `IsPublished` boolean: Indicates if the restaurant is published
    - `FlipdishStripeCustomConnectedAccounts` integer[]: List of Flipdish Stripe custom connected account identifiers

## Other responses

- `400`: BadRequest
- `401`: Authentication has been denied for this request.
- `403`: Successful authentication, but authorization has been denied for this request.

---

[API](https://skmtc.dev/flipdish/apis/flipdish-open-api-v1-0.md) · [All operations](https://skmtc.dev/flipdish/apis/flipdish-open-api-v1-0/llms.txt) · [OpenAPI document](https://skmtc.dev/flipdish/apis/flipdish-open-api-v1-0/revisions/4d8c2b9e1c13?raw)