Retrieve a brand
curl --request GET \
--url https://panel.sendcloud.sc/api/v2/brands/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://panel.sendcloud.sc/api/v2/brands/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://panel.sendcloud.sc/api/v2/brands/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://panel.sendcloud.sc/api/v2/brands/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://panel.sendcloud.sc/api/v2/brands/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://panel.sendcloud.sc/api/v2/brands/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://panel.sendcloud.sc/api/v2/brands/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"id": 1,
"name": "Sendcloud B.V",
"color": "#112857",
"secondary_color": "#112855",
"website": "https://www.sendcloud.com",
"overlay_logo": {},
"screen_logo": {
"url": "https://media.sendcloud.sc/brands/1/Sendcloud.png"
},
"print_logo": {
"url": "https://media.sendcloud.sc/brands/1/Sendcloud.png"
},
"overlay_thumb": {},
"screen_thumb": "https://media.sendcloud.sc/brands/1/a05d525e580da030907607d901e10288_thumbnail.png",
"print_thumb": "https://media.sendcloud.sc/brands/1/a05d525e580da030907607d901e10288_thumbnail.png",
"notify_reply_to_email": "info@sendcloud.com",
"domain": "sendcloud-shop",
"notify_bcc_email": "info@sendcloud.com",
"hide_powered_by": false,
"google_analytics_id": "G-1234567890",
"features": {
"tracking_page": true,
"tracking_email": true,
"tracking_sms": false,
"tracking_whatsapp": false,
"returns_portal": true
},
"customization_settings": {
"header": {
"faq_url": "https://support.sendcloud.com/hc/en-us",
"shop_url": "https://sendcloud.com/storefront",
"font_color": "#212121",
"contact_url": "https://sendcloud.com/contact",
"homepage_url": "https://sendcloud.com",
"background_color": "#ffffff"
},
"footer": {
"city": "Eindhoven",
"street": "Stadhuisplein",
"country": "Netherlands",
"font_color": "#212121",
"postal_code": "5611 EM",
"phone_number": "+310612345678",
"social_media": {
"twitter": "sendcloud",
"facebook": "SendCloudNL",
"linkedin": "sendcloud",
"instagram": "sendcloud",
"pinterest": "sendcloud"
},
"support_email": "contact@sendcloud.com",
"background_color": "#ffffff"
}
}
}{
"error": {
"code": 404,
"request": "api/v2/brands/184",
"message": "No Brand matches the given query."
}
}Brands API
Retrieve a brand
Retrieves a user’s configured brand and its properties, identified by its unique ID
GET
/
brands
/
{id}
Retrieve a brand
curl --request GET \
--url https://panel.sendcloud.sc/api/v2/brands/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://panel.sendcloud.sc/api/v2/brands/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://panel.sendcloud.sc/api/v2/brands/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://panel.sendcloud.sc/api/v2/brands/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://panel.sendcloud.sc/api/v2/brands/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://panel.sendcloud.sc/api/v2/brands/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://panel.sendcloud.sc/api/v2/brands/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"id": 1,
"name": "Sendcloud B.V",
"color": "#112857",
"secondary_color": "#112855",
"website": "https://www.sendcloud.com",
"overlay_logo": {},
"screen_logo": {
"url": "https://media.sendcloud.sc/brands/1/Sendcloud.png"
},
"print_logo": {
"url": "https://media.sendcloud.sc/brands/1/Sendcloud.png"
},
"overlay_thumb": {},
"screen_thumb": "https://media.sendcloud.sc/brands/1/a05d525e580da030907607d901e10288_thumbnail.png",
"print_thumb": "https://media.sendcloud.sc/brands/1/a05d525e580da030907607d901e10288_thumbnail.png",
"notify_reply_to_email": "info@sendcloud.com",
"domain": "sendcloud-shop",
"notify_bcc_email": "info@sendcloud.com",
"hide_powered_by": false,
"google_analytics_id": "G-1234567890",
"features": {
"tracking_page": true,
"tracking_email": true,
"tracking_sms": false,
"tracking_whatsapp": false,
"returns_portal": true
},
"customization_settings": {
"header": {
"faq_url": "https://support.sendcloud.com/hc/en-us",
"shop_url": "https://sendcloud.com/storefront",
"font_color": "#212121",
"contact_url": "https://sendcloud.com/contact",
"homepage_url": "https://sendcloud.com",
"background_color": "#ffffff"
},
"footer": {
"city": "Eindhoven",
"street": "Stadhuisplein",
"country": "Netherlands",
"font_color": "#212121",
"postal_code": "5611 EM",
"phone_number": "+310612345678",
"social_media": {
"twitter": "sendcloud",
"facebook": "SendCloudNL",
"linkedin": "sendcloud",
"instagram": "sendcloud",
"pinterest": "sendcloud"
},
"support_email": "contact@sendcloud.com",
"background_color": "#ffffff"
}
}
}{
"error": {
"code": 404,
"request": "api/v2/brands/184",
"message": "No Brand matches the given query."
}
}OAuth2 scopes required:
read:brand. See Scopes for OAuth apps.API v2 is entering maintenance mode. New users should start with API v3 to access our latest features and improved performance. Already using v2? Don’t worry, your current integration remains fully functional. Read more about maintenance mode, or check out the migration guide for API v3.
Authorizations
HTTPBasicAuthOAuth2ClientCreds
Path Parameters
Response
OK
A user's configured brand within Sendcloud
BCC email address used for reply to actions for tracking email notifications
Example:
"info@sendcloud.com"