Skip to main content
GET
/
brands
List brands
curl --request GET \
  --url https://api.courier.com/brands \
  --header 'Authorization: Bearer <token>'
{
  "paging": {
    "cursor": "<string>",
    "more": true
  },
  "results": [
    {
      "id": "<string>",
      "name": "<string>",
      "published": 123,
      "created": 123,
      "updated": 123,
      "settings": {
        "colors": {
          "primary": "<string>",
          "secondary": "<string>"
        },
        "email": {
          "templateOverride": {
            "backgroundColor": "<string>",
            "blocksBackgroundColor": "<string>",
            "enabled": true,
            "footer": "<string>",
            "head": "<string>",
            "header": "<string>",
            "width": "<string>",
            "mjml": {
              "backgroundColor": "<string>",
              "blocksBackgroundColor": "<string>",
              "enabled": true,
              "footer": "<string>",
              "head": "<string>",
              "header": "<string>",
              "width": "<string>"
            },
            "footerBackgroundColor": "<string>",
            "footerFullWidth": true
          },
          "head": {
            "inheritDefault": true,
            "content": "<string>"
          },
          "footer": {
            "content": "<string>",
            "inheritDefault": true
          },
          "header": {
            "inheritDefault": true,
            "barColor": "<string>",
            "logo": {
              "href": "<string>",
              "image": "<string>"
            }
          }
        },
        "inapp": {
          "borderRadius": "<string>",
          "disableMessageIcon": true,
          "fontFamily": "<string>",
          "placement": "top",
          "widgetBackground": {
            "topColor": "<string>",
            "bottomColor": "<string>"
          },
          "colors": {
            "primary": "<string>",
            "secondary": "<string>"
          },
          "icons": {
            "bell": "<string>",
            "message": "<string>"
          }
        }
      },
      "snippets": {
        "items": [
          {
            "name": "<string>",
            "value": "<string>"
          }
        ]
      },
      "version": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cursor
string | null

A unique identifier that allows for fetching the next set of brands.

Response

200 - application/json
paging
object
required
results
Brand · object[]
required