Skip to main content
GET
/
brands
Retrieve a list of brands
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/brands \
  --header 'Authorization: Basic <encoded-value>'
{
  "next": null,
  "previous": null,
  "brands": [
    {
      "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",
          "contact_url": "https://sendcloud.com/contact",
          "shop_url": "https://sendcloud.com/storefront",
          "font_color": "#212121",
          "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",
          "whatsapp_business": "+310612345678"
        }
      }
    }
  ]
}
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

Authorization
string
header
required

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

Response

200 - application/json

OK

next
string | null

Url to retrieve the next page of brands

previous
string | null

Url to retrieve the next page of brands

brands
Brand Object · object[]