API Documentation

# List Brands v1.0

The List Brands endpoint allows a developer to retrieve a list of brands.

GET /brand-api/v1.0/brands[?filterDisabled][&expand]

# Request

The endpoint supports array expansion. Parameters can be applied to narrow down the brands and expands can be used to retrieve entire brands with all of their data.

# Query Parameters

A list of the supported query parameters is described below.

Name Required Type Description
filterDisabled false boolean Filters disabled brands 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.

# 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 restaurants 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 Brand resources wrapped in an ApiListResponse envelope.

# Response Body

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

# Sample

{
    "message": "The operation succeeded! 25 records returned.",
    "notifications": [],
    "numberOfRecords": 25,
    "data": [
        {
            "key": "DOREGOS",
            "name": "DoRegos",
            "displayName": "DoRegos",
            "enabled": false,
            "menus": [],
            "restaurants": [],
            "createdOn": "2013-09-25T13:37:28.8966667",
            "modifiedOn": "2019-06-20T19:41:17.7000002"
        },
        {
            "key": "RIBSHACK",
            "name": "RibShack RocoFellas",
            "displayName": "RibShack RocoFellas",
            "enabled": true,
            "menus": [],
            "restaurants": [],
            "createdOn": "2020-07-06T14:46:47.6033333",
            "modifiedOn": "2020-09-05T13:40:44.2522032"
        },
        {
            "key": "ROCO",
            "name": "RocoMamas",
            "displayName": "RocoMamas",
            "enabled": true,
            "menus": [],
            "restaurants": [],
            "createdOn": "2015-03-26T20:22:35.17",
            "modifiedOn": "2021-02-02T19:55:08.3733333"
        },
        {
            "key": "SPUR",
            "name": "Spur",
            "displayName": "Spur",
            "enabled": true,
            "menus": [],
            "restaurants": [],
            "createdOn": "2013-09-25T13:37:28.8966667",
            "modifiedOn": "2021-02-03T09:55:06.4333333"
        },
        {
            // Other brands omitted for brevity.
        }
    ]
}

# Errors

The standard error responses apply.

400
Bad Request
When the expand provided is invalid.

← Get Brand →