Fetch the authenticated brand's profile (POL-716).

GET

/brands/me

• Production
• Staging
• Local dev

Returns the brand associated with the caller’s Trusted App plus the scopes granted to the current bearer token. Used by @polst-web/sdk BrandClient.me() as the canonical ‘who am I’ probe.

Authorizations

• bearerAuth

Responses

200

Authenticated brand profile.

object

data

required

object

slug

required

string

>= 1 characters

name

required

string

>= 1 characters

displayName

required

Any of:

string

string

null

null

description

required

Any of:

string

string

null

null

avatarUrl

required

Any of:

string

string

null

null

location

required

Any of:

string

string

null

null

theme

required

object

accent

required

Any of:

string

string

/^#([0-9a-f]{6}|[0-9a-f]{8})$/

null

null

background

required

Any of:

string

string

/^#([0-9a-f]{6}|[0-9a-f]{8})$/

null

null

foreground

required

Any of:

string

string

/^#([0-9a-f]{6}|[0-9a-f]{8})$/

null

null

radius

required

string

Allowed values: NONE SM MD LG FULL

density

required

string

Allowed values: COMPACT COMFORTABLE

fontStack

required

string

Allowed values: SYSTEM SERIF MONO BRAND

fontBrandUrl

required

Any of:

string

string

<= 2048 characters

null

null

logoLightUrl

required

Any of:

string

string

<= 2048 characters

null

null

logoDarkUrl

required

Any of:

string

string

<= 2048 characters

null

null

faviconUrl

required

Any of:

string

string

<= 2048 characters

null

null

hideWatermark

required

boolean

customCss

required

Any of:

string

string

<= 4096 characters

null

null

version

required

integer

<= 9007199254740991

titleColor

required

Any of:

string

string

/^#([0-9a-f]{6}|[0-9a-f]{8})$/

null

null

titleSize

required

Any of:

integer

integer

>= 10 <= 96

null

null

titleWeight

required

Any of:

integer

integer

>= 100 <= 900

null

null

titlePlacement

required

string

Allowed values: ABOVE BELOW HIDDEN

labelColor

required

Any of:

string

string

/^#([0-9a-f]{6}|[0-9a-f]{8})$/

null

null

labelSize

required

Any of:

integer

integer

>= 10 <= 72

null

null

labelPlacement

required

string

Allowed values: HEADER OVERLAID BELOW HIDDEN

labelAlign

required

string

Allowed values: LEFT CENTER

headerFill

required

Any of:

string

string

/^#([0-9a-f]{6}|[0-9a-f]{8})$/

null

null

orBadgeBg

required

Any of:

string

string

/^#([0-9a-f]{6}|[0-9a-f]{8})$/

null

null

orBadgeFg

required

Any of:

string

string

/^#([0-9a-f]{6}|[0-9a-f]{8})$/

null

null

orBadgeDiameter

required

Any of:

integer

integer

>= 24 <= 96

null

null

imageRatio

required

Any of:

number

number

>= 0.25 <= 4

null

null

elevation

required

string

Allowed values: FLAT LIFTED

brandId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

scopes

required

Array<string>

401

Missing or invalid bearer token.

403

Bearer token lacks view scope or brand context.

404

Brand not found (stale app → deleted brand).