Retrieve a brand
curl --request GET \
--url https://panel.sendcloud.sc/api/v3/brands/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://panel.sendcloud.sc/api/v3/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/v3/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/v3/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/v3/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/v3/brands/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://panel.sendcloud.sc/api/v3/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{
"data": {
"id": 1,
"name": "Sendcloud B.V",
"domain": "sendcloud-shop",
"color": "#112857",
"website": "https://www.sendcloud.com",
"screen_logo": "https://media.sendcloud.sc/brands/1/Sendcloud.png",
"print_logo": "https://media.sendcloud.sc/brands/1/Sendcloud.png",
"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",
"notify_bcc_email": "info@sendcloud.com",
"hide_powered_by": false,
"google_analytics_id": "G-1234567890"
}
}{
"errors": [
{
"status": "404",
"code": "not_found",
"detail": "No Brand matches the given query."
}
]
}Brands
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/v3/brands/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://panel.sendcloud.sc/api/v3/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/v3/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/v3/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/v3/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/v3/brands/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://panel.sendcloud.sc/api/v3/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{
"data": {
"id": 1,
"name": "Sendcloud B.V",
"domain": "sendcloud-shop",
"color": "#112857",
"website": "https://www.sendcloud.com",
"screen_logo": "https://media.sendcloud.sc/brands/1/Sendcloud.png",
"print_logo": "https://media.sendcloud.sc/brands/1/Sendcloud.png",
"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",
"notify_bcc_email": "info@sendcloud.com",
"hide_powered_by": false,
"google_analytics_id": "G-1234567890"
}
}{
"errors": [
{
"status": "404",
"code": "not_found",
"detail": "No Brand matches the given query."
}
]
}OAuth2 scopes required:
read:brand. See Scopes for OAuth apps.Authorizations
HTTPBasicAuthOAuth2ClientCreds
Basic Authentication using API key and secrets is currently the main authentication mechanism.
Path Parameters
The unique id of the user's configured brand.
Required range:
x >= 1Example:
1
Response
OK
Response schema for the brand endpoint.
Schema representing a brand.
Show child attributes
Show child attributes