Get organization brands - Way Docs

GET

/

v1

/

organizations

/

{organizationId}

/

brands

Get organization brands

curl --request GET \
  --url https://api.letsway.com/v1/organizations/{organizationId}/brands \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.letsway.com/v1/organizations/{organizationId}/brands', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.letsway.com/v1/organizations/{organizationId}/brands"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "items": [
    {
      "id": "b91e63ed-026c-4bd1-ae92-c910f20b9aa0",
      "name": "The City Hotel",
      "tier": "growth",
      "countryCode": "US",
      "currency": "USD",
      "creditCardFeePercentage": 2.9,
      "isTestBrand": false,
      "isCuratedBrand": false,
      "churnedAt": null,
      "organizationId": "94a6fbf3-586f-42fb-b52a-90fa962bc4d7",
      "products": [
        "host",
        "activate",
        "reserve"
      ],
      "emailAddress": "alice@example.com",
      "csmUser": null,
      "logoUri": null,
      "deletedAt": null
    }
  ]
}

Authorizations

Authorization

string

header

required

Your organization's secret API key, e.g. Bearer way_sk_live_ohEqcn0i1fRoUEHBPjJkQA. Older Way-Organization-Id + Way-Secret-Key credentials still work: see Legacy authentication.

Path Parameters

organizationId

string

required

Only bookings belonging to this organization.

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.

Show child attributes

meta

object

required

Show child attributes

links

object

Show child attributes

⌘I

Get organization brands

curl --request GET \
  --url https://api.letsway.com/v1/organizations/{organizationId}/brands \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.letsway.com/v1/organizations/{organizationId}/brands', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.letsway.com/v1/organizations/{organizationId}/brands"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "items": [
    {
      "id": "b91e63ed-026c-4bd1-ae92-c910f20b9aa0",
      "name": "The City Hotel",
      "tier": "growth",
      "countryCode": "US",
      "currency": "USD",
      "creditCardFeePercentage": 2.9,
      "isTestBrand": false,
      "isCuratedBrand": false,
      "churnedAt": null,
      "organizationId": "94a6fbf3-586f-42fb-b52a-90fa962bc4d7",
      "products": [
        "host",
        "activate",
        "reserve"
      ],
      "emailAddress": "alice@example.com",
      "csmUser": null,
      "logoUri": null,
      "deletedAt": null
    }
  ]
}