API Documentation

# List Restaurants v1.0

The List Restaurants endpoint retrieves a list of restaurants. The endpoint supports array expansion, paging and filtering by selected properties. Parameters can be applied to narrow down the restaurants and expands can be used to retrieve related data.

# Request

GET /restaurant-api/v1.0/restaurants[?countryCode][&brandKey][&brandKeys][&tradingStatus][&restaurantType][&filterHidden][&expand][&pageSize][&pageNumber]

# Query Parameters

A list of the supported query parameters is described below.

Name Required Type Description
countryCode false string Filters restaurants based on an ISO 3166-1 Alpha-2 country code.
brandKey false in Filters restaurants based on a single brand key.
brandKeys false string[] Filters restaurants based on two or more comma separated brand keys.
tradingStatus false string Filters restaurants based on trading status. Valid values are: 'Open' or 'Closed'.
restaurantType false string Filters restaurants based on type.
filterHidden false boolean Filters restaurants marked as hidden from the response.
expand false string[] Provide a list of array properties that should be expanded in the response. See Expands below for more information.
pageSize false boolean The number of restaurants to return per page. If the parameter is omitted, paging is not applied.
pageNumber false boolean The page number to return. If the parameter is omitted, paging is not applied.

# Expands

The expand parameter allows some arrays in the response object to be expanded in the response. We support this to allow you to control the amount of data you will get in the response. Pick only the data you need for the specific scenario and we'll send you less data, faster.

Valid values are: menus or urls or services or tradingTimes or any combination thereof.

WARNING

Expanding arrays increases the response time as more data needs to be fetched and processed. A request with no filters and all the expands specified results in a large JSON response.

# Response

200
OK
Returns an array of Restaurant resources wrapped in an ApiListResponse envelope.

# Response Body

The endpoint returns our ApiPagedListResponse envelope. The data property of the response will contain an array of Restaurant resources.

# Sample

{
    "message": "The operation succeeded! 7 records returned.",
    "notifications": [],
    "numberOfRecords": 2,
    "totalRecords": 2,
    "pageSize": 1,
    "pageNumber": 1,
    "pageCount": 1,
    "hasPreviousPage": false,
    "hasNextPage": false,
    "data": [
        {
            "key": 1245,
            "accountKey": 411000892,
            "name": "GG Breede Valley South",
            "displayName": "Grill & Go Breede Valley South",
            "brand": {
                "key": "GNG",
                "name": "Grill and Go",
                "displayName": "Grill and Go",
                "enabled": true,
                "createdOn": "2015-10-15T20:16:39.92",
                "modifiedOn": "2021-02-14T13:15:05.8166667"
            },
            "outletType": "Restaurant",
            "restaurantType": "Standard",
            "restaurantStatus": "Open",
            "tradingStatus": "Open",
            "active": true,
            "emailAddress": "breedevalleysouth@spurgrillandgo.com",
            "alternateEmailAddress": null,
            "telephoneNumber": "023-342 5486",
            "alternateTelephoneNumber": null,
            "streetAddress": "Ultra City Breede Valley - South, N1 Highway",
            "addressLine1": "Ultra City Breede Valley - South",
            "addressLine2": "N1 Highway",
            "suburb": null,
            "city": "Worcester",
            "province": "Western Cape",
            "countryCode": "ZA",
            "countryName": "South Africa",
            "latitude": -33.633748,
            "longitude": 19.359052,
            "utcOffset": "+02:00",
            "utcOffsetMinutes": 120,
            "tradingTimes": [],
            "playArea": false,
            "caterForDisabled": true,
            "smokingSection": false,
            "wireless": true,
            "halaal": true,
            "liquorLicence": false,
            "tradeOffPowerGrid": true,
            "floorArea": 148,
            "numberOfTables": 23,
            "numberOfSeats": 82,
            "greenEcoStatusRating": 0,
            "orderingServices": [],
            "urls": [],
            "pointOfSale": "Pilot",
            "posLinkCode": "6060",
            "menus": [],
            "createdOn": "2015-10-22T15:15:21.8266667",
            "modifiedOn": "2021-02-16T20:00:03.68"
        },
        {
            "key": 1246,
            "accountKey": 411000893,
            "name": "GG Breede Valley North",
            "displayName": "Grill & Go Breede Valley North",
            "brand": {
                "key": "GNG",
                "name": "Grill and Go",
                "displayName": "Grill and Go",
                "enabled": true,
                "createdOn": "2015-10-15T20:16:39.92",
                "modifiedOn": "2021-02-14T13:15:05.8166667"
            },
            "outletType": "Restaurant",
            "restaurantType": "Standard",
            "restaurantStatus": "Open",
            "tradingStatus": "Open",
            "active": true,
            "emailAddress": "breedevalleynorth@spurgrillandgo.com",
            "alternateEmailAddress": null,
            "telephoneNumber": "023-342 5486",
            "alternateTelephoneNumber": null,
            "streetAddress": "Ultra City Breede Valley - North, N1 Highway",
            "addressLine1": "Ultra City Breede Valley - North",
            "addressLine2": "N1 Highway",
            "suburb": "Breede Valley",
            "city": "Worcester",
            "province": "Western Cape",
            "countryCode": "ZA",
            "countryName": "South Africa",
            "latitude": -33.635757,
            "longitude": 19.356302,
            "utcOffset": "+02:00",
            "utcOffsetMinutes": 120,
            "tradingTimes": [],
            "playArea": false,
            "caterForDisabled": true,
            "smokingSection": false,
            "wireless": true,
            "halaal": false,
            "liquorLicence": true,
            "tradeOffPowerGrid": true,
            "floorArea": 148,
            "numberOfTables": 23,
            "numberOfSeats": 82,
            "greenEcoStatusRating": 1,
            "orderingServices": [],
            "urls": [],
            "pointOfSale": "Pilot",
            "posLinkCode": "6059",
            "menus": [],
            "createdOn": "2015-10-22T15:40:45.1766667",
            "modifiedOn": "2021-02-17T00:00:00"
        },
        {
            // Other restaurants omitted for brevity.
        }
    ]
}

# Errors

The standard error responses apply.

400
Bad Request
When the expand provided is invalid.

← Get Restaurant →