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

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
cursor
string

The cursor query string is used as the pivot value to filter results. If no value is provided, the first page of results will be returned. To get this value, you must encode the offset, reverse and position into a base64 string.

There are 3 possible parameters to encode:

  • o: Offset
  • r: Reverse
  • p: Position

For example, r=1&p=300 encoded as a base64 string would be cj0xJnA9MzAw. The query string would then be cursor=cj0xJnA9MzAw.

Example:

"cj0xJnA9MzAw"

​
page_size
integer

The size of the page to fetch.

Required range: x <= 100

Response

200 - application/json

OK

​
data
BrandSchema · object[]

A list of the user's configured brands.