List Brands
list_brandsRetrieve all brands in a Wistia account, including branding options like colors, fonts, logos, and layout, and identify the default brand used for unbranded media.
Instructions
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 dataTokens 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.
Read-only account operation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | The page number to retrieve. This cannot be combined with `cursor`, pagination. | |
| cursor | No | 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. | |
| account | No | Named private Wistia account; selects credentials, not a remote account ID. | |
| sort_by | No | Ordering. When using cursor pagination (see cursor param), only `id`, `updated` and `created` are supported. All other sort_by options require offset pagination. | |
| per_page | No | The number of medias per page. Use this for both offset pagination and cursor pagination. | |
| all_pages | No | Read bounded page/per_page pages; each request consumes API quota. Not a snapshot or guaranteed complete backup. | |
| max_items | No | Maximum returned records with all_pages=true, default 1000. At most 100 requests; output includes continuation state. | |
| sort_direction | No | Ordering Sort Direction (0 = desc, 1 = asc) |