Skip to main content
GET
Get organization brands

Authorizations

Authorization
string
header
required

Your organization's secret API key, e.g. Bearer way_sk_live_ohEqcn0i1fRoUEHBPjJkQA. The key authorizes every brand in the organization but does not by itself name one: see the endpoint description for how this request is scoped. Using Way-Organization-Id + Way-Secret-Key credentials? See Legacy authentication.

Path Parameters

organizationId
string
required

The organization's ID. Must be your key's own organization, or one below it in the organization tree.

Query Parameters

limit
number
default:10

Number of items per page.

Required range: x >= 1
page
number
default:1

Page number to return, starting at 1.

Required range: x >= 1
sortBy
enum<string>

Field to sort the results by.

Available options:
name,
emailAddress,
tier,
creditCardFeePercentage
sortDir
enum<string>

Sort direction.

Available options:
ASC,
DESC

Response

200 - application/json

Brands.

items
object[]
required

The organization's brands for the requested page.

meta
object
required