Skip to main content
GET
/
brands
/
{id}
Retrieve a brand
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/brands/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "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"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Path Parameters

​
id
integer
required

The unique id of the user's configured brand

Required range: x >= 1
Example:

1

Response

OK

A user's configured brand within Sendcloud

​
id
integer
required

The unique identifier of the brand

Required range: x >= 1
Example:

1

​
name
string
required

The brand name

Minimum string length: 1
Example:

"Sendcloud B.V"

​
domain
string
required

A user-defined domain for use with the tracking page and the return portal features.

Minimum string length: 1
Example:

"sendcloud-shop"

​
features
object
required

List of features activated for the brand

​
color
string

Hex code of the primary brand color

Required string length: 7
Example:

"#112857"

​
secondary_color
string

Hex code of the secondary brand color

Required string length: 7
Example:

"#112855"

​
website
string<uri>

The website of the specific brand, usually used for display purposes

Minimum string length: 1
Example:

"https://www.sendcloud.com"

The brand's logo used for display purposes

Deprecated. Returns an empty object to not break backward compatibility

The brand's logo used for printing purposes (e.g. labels)

​
overlay_thumb
object
deprecated

Deprecated. Returns an empty object to not break backward compatibility

​
screen_thumb
string<uri> | null

Thumbnail of the screen logo

Example:

"https://media.sendcloud.sc/brands/1/a05d525e580da030907607d901e10288_thumbnail.png"

​
print_thumb
string<uri> | null

Thumbnail of the print logo

Example:

"https://media.sendcloud.sc/brands/1/a05d525e580da030907607d901e10288_thumbnail.png"

​
notify_reply_to_email
string<email> | null

Email address used for reply to actions for tracking email notifications

Example:

"info@sendcloud.com"

​
notify_bcc_email
string<email> | null

BCC email address used for reply to actions for tracking email notifications

Example:

"info@sendcloud.com"

​
hide_powered_by
boolean
default:false

Indicates if the "powered by Sendcloud" message should be displayed on features which display the user's brand, such as the tracking page

​
google_analytics_id
string

A user-defined string representing the Google Analytics ID

Maximum string length: 15
Example:

"G-1234567890"

​
customization_settings
object

Header and footer customization settings for the brand