# Get Brand v1.0

The Get Brand endpoint allows a developer to retrieve a single brand.

GET /brand-api/v1.0/brand/{key}[?expand]

# Request

The request will get a single brand. Expands can be used to retrieve a brand with all of its related data.

# Path Parameters

A list of the supported path parameters is described below.

Name	Required	Type	Description
key	true	string	The key for the brand.

# Query Parameters

A list of the supported query parameters is described below.

Name	Required	Type	Description
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.

# Response

200

Returns a Brand resource wrapped in an ApiResponse envelope.

# Response Body

The endpoint returns our ApiResponse envelope. The data property of the response will contain a Brand resource.

# Sample

{
    "message": "The operation succeeded!",
    "notifications": [],
    "data": {
        "key": "ROCO",
        "name": "RocoMamas",
        "displayName": "RocoMamas",
        "enabled": true,
        "menus": [],
        "restaurants": [],
        "createdOn": "2015-03-26T20:22:35.17",
        "modifiedOn": "2021-02-02T19:55:08.3733333"
    }
}

# Errors

The standard error responses apply.

404

Not Found

When the requested brand cannot be found.

← List Brands