Get restaurant configuration information

Returns a RestaurantInfo object that contains detailed information about the configuration of a restaurant.

Request

path Parameters

• restaurantGUID required:
  string

  The Toast GUID of the restaurant that you want to get information about.

header Parameters

• Toast-Restaurant-External-ID required:
  string <string>

  The Toast GUID of the restaurant that you want to get information about.

Responses

200

A RestaurantInfo object that contains detailed information about the configuration of a restaurant.

get /restaurants/{restaurantGUID}

Request samples

curl -i -X GET \
  'https://toast-api-server/restaurants/v1/restaurants/{restaurantGUID}' \
  -H 'Toast-Restaurant-External-ID: string'

Response samples

application/json

{
  "guid": "string",
  "general": {
    "name": "string",
    "locationName": "string",
    "locationCode": "string",
    "description": "string",
    "timeZone": "string",
    "closeoutHour": 0,
    "managementGroupGuid": "string"
  },
  "urls": {
    "website": "string",
    "facebook": "string",
    "twitter": "string",
    "orderOnline": "string",
    "purchaseGiftCard": "string",
    "checkGiftCard": "string"
  },
  "location": {
    "address1": "string",
    "address2": "string",
    "city": "string",
    "stateCode": "string",
    "zipCode": "string",
    "country": "string",
    "phone": "string",
    "latitude": 0,
    "longitude": 0
  },
  "schedules": {
    "daySchedules": {
      "identifier": "string",
      "property1": {
        "scheduleName": "string",
        "services": [
          {
            "name": "string",
            "hours": {
              "startTime": "string",
              "endTime": "string"
            },
            "overnight": true
          }
        ],
        "openTime": "string",
        "closeTime": "string"
      },
      "property2": {
        "scheduleName": "string",
        "services": [
          {
            "name": "string",
            "hours": {
              "startTime": "string",
              "endTime": "string"
            },
            "overnight": true
          }
        ],
        "openTime": "string",
        "closeTime": "string"
      }
    },
    "weekSchedule": {
      "monday": "string",
      "tuesday": "string",
      "wednesday": "string",
      "thursday": "string",
      "friday": "string",
      "saturday": "string",
      "sunday": "string"
    }
  },
  "delivery": {
    "enabled": true,
    "minimum": 0,
    "area": "string"
  },
  "onlineOrdering": {
    "enabled": true,
    "scheduling": true,
    "specialRequests": true,
    "specialRequestsMessage": "string",
    "paymentOptions": {
      "delivery": {
        "cash": true,
        "ccSameDay": true,
        "ccFuture": true
      },
      "takeout": {
        "cash": true,
        "ccSameDay": true,
        "ccFuture": true,
        "ccInStore": true
      },
      "ccTip": true
    }
  },
  "prepTimes": {
    "deliveryPrepTime": 0,
    "deliveryTimeAfterOpen": 0,
    "deliveryTimeBeforeClose": 0,
    "takeoutPrepTime": 0,
    "takeoutTimeAfterOpen": 0,
    "takeoutTimeBeforeClose": 0,
    "takeoutThrottlingTime": 0,
    "deliveryThrottlingTime": 0
  }
}