Brands - Show All



Endpoint

GET /v1.1/brands

Description

Return a list of all of the brands, with associated brand detail, currently monitored by your Appreciation Engine account.

Parameters
required *

apiKey *  string Your API access key
asList  string Set to 1 to return a list of all of your brands in list form with just ID and Name. Useful for menu creation
orderBy  string Order your brands by 'Name' (default) or 'Recent' (last edited date)
limit  string Limit the results, eg 'limit=10' or 'limit=10,10' (offset,limit)

Sign in with your developer account to use the console, or sign up here

Example Request

curl -v -X GET "https://api.theappreciationengine.com/v1.1/brands?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&limit=10"
$curl = curl_init();

curl_setopt_array($curl, array( 
	CURLOPT_URL => "https://api.theappreciationengine.com/v1.1/brands?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&limit=10", 
	CURLOPT_RETURNTRANSFER => true, 
	CURLOPT_ENCODING => "", 
	CURLOPT_MAXREDIRS => 10, 
	CURLOPT_TIMEOUT => 0, 
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, 
	CURLOPT_CUSTOMREQUEST => "GET", 
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
import requests

url = "https://api.theappreciationengine.com/v1.1/brands?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&limit=10"

headers = {}
payload = {}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text.encode('utf8'))
var request = require('request');
var options = {
	'method': 'GET',
	'url': 'https://api.theappreciationengine.com/v1.1/brands?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&limit=10',
	'headers': {}
};
request(options, function (error, response) {
	if (error) throw new Error(error);
	console.log(response.body);
});

Example Response

{
"totalSize":2,
"items":[
{
"Name": "Starfleet",
"Slug": "starfleet",
"Type": "TV",
"OfficialWebsiteURL": "https://memory-alpha.fandom.com/wiki/Starfleet",
"FacebookURL": "https://www.facebook.com/StarTrekFleetCommand",
"FacebookID": "153926535321487",
"TwitterURL": "https://twitter.com/hashtag/starfleet",
"TwitterScreenName": "starfleet",
"TwitterID": "1011038466996662273",
"SpotifyURL": "https://open.spotify.com/artist/4vOkauYTuQV2cDee4YsERr",
"SpotifyID": "4vOkauYTuQV2cDee4YsERr",
"WikipediaURL": "https://en.wikipedia.org/wiki/Starfleet",
"ID": 1701,
"ImageURL": "http://someurl.com/brand/starfleet/image"
},
{
"Name":"Commander Data Detective Agency Inc",
"Slug":"commander-data-detective-agency-inc",
"Type":"consumer",
"OfficialWebsiteURL":"http//www.commanderdatadetectiveagencyinc.com",
"FacebookURL":"https://www.facebook.com/commanderdatadetectiveagencyinc",
"FacebookID":"12335",
"YouTubeURL":"https://www.youtube.com/user/commanderdatadetectiveagencyinc",
"YouTubeUsername":"CommanderDataDetectiveAgencyInc",
"TwitterURL":"https://twitter.com/commanderdatadetectiveagencyinc",
"TwitterScreenName":"Commander Data Detective Agency Inc",
"TwitterID":"415864",
"InstagramURL":"https://instagram.com/commanderdatadetectiveagencyinc",
"InstagramUsername":"commanderdatadetectiveagencyinc",
"TumblrURL":"http://commanderdatadetectiveagencyinc.tumblr.com/",
"HashTag":"commanderdatawillsolveyourmystery",
"DeezerURL":"http://www.deezer.com/artist/123",
"DeezerName":"commanderdatadetectiveagencyinc",
"DeezerID":"123",
"WikipediaURL":"https://en.wikipedia.org/wiki/commanderdatadetectiveagencyinc",
"ImageURL":"https://www.someurl.com",
"ID":"321321321",
"ShopifyStoreURL":"https://www.commanderdatadetectiveagencyinc.com/store",
"ShopifyAPIKey":"kytdcufyvgubhiunjoimkp",
"ShopifyAPISecret":"cgfhvbjknlmfcghvbj",
"ShopifyMultipass":"xfdcghvbjknlmfcghvbjknlm"
}
]
}