Get the branding of an App: name, web address, look, colors, logo, icon and tabs

GET

/apps/{appId}/branding

const url = 'https://api.passion.io/v1/apps/example/branding';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.passion.io/v1/apps/example/branding

Parameters

Path Parameters

appId

required

The id of the App, as Studio shows it.

string

/^[1-9][0-9]*$/

Responses

200

application/json

object

name

required

string

webAddress

required

Any of:

string
null

string

supportEmail

required

Any of:

string
null

string

look

required

Any of:

object
null

object

tint

required

string

Allowed values: neutral brand warm cool solid

solidColor

required

Any of:

string
null

string

accent

required

string

Allowed values: none tonal analogous

cards

required

string

Allowed values: soft flat outlined raised

bars

required

string

Allowed values: glass solid

typeScale

required

string

Allowed values: standard expressive

density

required

string

Allowed values: comfortable compact

tiles

required

string

Allowed values: square portrait wide

tileTitles

required

string

Allowed values: show hide

header

required

string

Allowed values: wash solid plain

continueCard

required

string

Allowed values: compact largeImage listRow hide

courseRows

required

string

Allowed values: carousel grid

colors

required

Any of:

object
null

object

key

additional properties

string

font

required

Any of:

string
null

string

corners

required

Any of:

string
null

string

logoUrl

required

Any of:

string
null

string

iconUrl

required

Any of:

string
null

string

tabs

required

The tabs of the member app, with their titles and icons. A tab that is off is hidden.

Array<object>

object

tab

required

string

Allowed values: discover learn community tracking profile

required

boolean

title

required

string

icon

required

Any of:

string
null

string

leads

required

Any of:

string
null

string

Allowed values: courses community assistant

Example

{
  "look": {
    "tint": "neutral",
    "accent": "none",
    "cards": "soft",
    "bars": "glass",
    "typeScale": "standard",
    "density": "comfortable",
    "tiles": "square",
    "tileTitles": "show",
    "header": "wash",
    "continueCard": "compact",
    "courseRows": "carousel"
  },
  "tabs": [
    {
      "tab": "discover"
    }
  ],
  "leads": "courses"
}