WIwistia
Brands

List Brands

Changed on

Lists the brands belonging to the account. A brand is a saved set of branding options (colors, fonts, logos, and layout) that can be applied to media, folders, and channels. The account-level default brand is flagged with is_default, and styles everything that has no brand of its own.

Requires api token with one of the following permissions

Read all data

Tokens with the "Act with a team member's permissions" permission (all:delegate_to_contact_permissions scope) can also be used. Requests made with such a token are authorized using the permissions of the contact assigned to the token.

An expiring access token created with the all:delegate_to_contact_permissions scope and an authorization naming a brand (any permission) can also be used; it lists the brands the token names.

get/brands

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/brands
  • Auth
    HTTP bearer

Query parameters

pageinteger

The page number to retrieve. This cannot be combined with cursor, pagination.

per_pageinteger

The number of medias per page. Use this for both offset pagination and cursor pagination.

enabled0 | 1

If cursor[enabled] is set to 1, the first result set will be fetched with cursor pagination enabled. This values is ignored if cursor[before] or cursor[after] are set.

beforestring

If cursor[before] is set then cursor pagination is enabled and all records before the cursor up to the per_page are returned. This feature is useful for fetching "new records", for example, in a "pull to refersh" feature when showing records in a descending order.

afterstring

If cursor[after] is set then cursor pagination is enabled and all records after the cursor up to the per_page are returned.

If cursor[enabled] is set to 1 then cursor pagination is enabled and the first set of records are fetched up to the per_page. Cursor pagination will also be turned on if cursor[before] or cursor[after] are set. Records returned will have a cursor property set which can be used to fetch more records in the same sort_by ordering. The cursor value of the last record can be used to fetch records after the current result set and the cursor of the first record can be used to fetch records before the result set.

NOTE: a cursor value is only valid if the sort_by value hasn't changed from the last fetch. For example, you cannot fetch using sort_by id and then pass that cursor value to a sort_by name.

sort_by'name' | 'created' | 'updated' | 'id'

Ordering. When using cursor pagination (see cursor param), only id, updated and created are supported. All other sort_by options require offset pagination.

sort_direction0 | 1

Ordering Sort Direction (0 = desc, 1 = asc)

Headers

X-Wistia-API-Versionstring required

Response

A list of brands

idstring

A unique alphanumeric identifier for this brand.

namestring

The brand's display name.

is_defaultboolean

Whether this brand is the account-level default, applied to content that has no more specific brand.

createdstring date-time

The date the brand was originally created.

updatedstring date-time

The date the brand was last updated.

body_font_familystring nullable

The brand font family for body text. Null when unset.

headline_font_familystring nullable

The brand font family for headlines. Null when unset.

button_font_familystring nullable

The brand font family for buttons. Null when unset.

border_radiusinteger nullable

The border radius in pixels for rounded corners. Null when unset.

contrast_icons'enabled' | 'disabled' | 'unset' | 'null' nullable

Controls whether the player icon color is always white or uses an accessible contrast color when necessary.

opaque_controls'enabled' | 'disabled' | 'unset' | 'null' nullable

Controls the opacity of the video player control bar and big play button.

cursorstring nullable

A cursor for stable pagination based on current sort_by order. You can pass this to cursor[before] or cursor[after] as a parameter to fetch the records before or after this record in the same sort order. This is only populated if records were fetched with cursor[enabled], or cursor[before] or cursor[after].

Example response

[
  {
    "id": "abcde12345",
    "name": "My Brand",
    "is_default": true,
    "created": "2010-08-13T18:47:39+00:00",
    "updated": "2010-08-19T21:47:00+00:00",
    "primary_color": "#2949E5",
    "page_background_color": "#2949E5",
    "body_font_family": "Inter",
    "headline_font_family": "GT Walsheim",
    "button_font_family": "Inter",
    "border_radius": 10
  }
]

Changes