Authentication

Every Way API request is authenticated with a single header - there are no tokens to refresh:

Authorization: Bearer way_sk_live_bMQ8BHPjMQX_97rJKxAVjkg

The key itself identifies your brand (or organization) and its environment, so no ID headers are needed.

Still sending Way-Brand-Id + Way-Secret-Key headers with an older key? That method keeps working - see Legacy authentication. You can switch at any time by creating a new key.

Create an API key

In the Way dashboard, go to Settings → Developers → API Keys and select Create API key. Name the key and choose its type:

Secret key (way_sk_...) - for server-to-server use. Send it as an Authorization: Bearer header and never expose it in a browser.
Publishable key (way_pk_...) - for browser use. It only works from the domains approved for your account, so add yours under approved domains first.

Creating a new API key in the Way dashboard

Secret keys must only be used from your server. Never embed one in client-side code or expose it to end users - use a publishable key in the browser instead.

Key format

way_<sk|pk>_<live|test>_<random>

Everything about the key is readable from its prefix:

Segment	Meaning
`sk` / `pk`	Secret or publishable key
`live` / `test`	Environment - `live` keys only work against production, `test` keys against staging. See Environments.

Verify your credentials

Fetch your brand’s settings (replace the Brand ID and key with your own):

curl \
     -X GET \
     -H "Authorization: Bearer [Your API Key]" \
     -H "Content-Type: application/json" \
     https://api.letsway.com/v1/brands/[Your Brand ID]/settings

If successful, you will receive a response that looks like the following:

{
  "data": {
    "brandEmail": "<string>",
    "paymentPlatform": "stripe-us",
    "currency": "USD",
    "wayVersion": "V1",
    "products": ["activate"],
    "paymentMethods": {
      "card": true,
      "apple_pay": true,
      "google_pay": true
    },
    "cancellationPolicyId": "<string>"
  }
}

Brand keys and organization keys

A key is issued to either a brand or an organization:

Brand key - created in your brand’s dashboard; scoped to that brand. A brandId in the path must be that brand, or the request fails with 403 Forbidden.
Organization key - created under Organizations → API Keys; authorizes every brand in your organization, including brands of child organizations.

Naming a brand with an organization key

An organization key authorizes every brand in the organization, but it does not by itself say which brand a request is about. How you name the brand depends on the endpoint, and each endpoint’s reference page states which of these applies:

The endpoint	What an organization key sends
Has `brandId` in the path, e.g. Get brand settings	Nothing extra. The path names the brand.
Is keyed by a resource ID, e.g. Get a cart or Get available dates	Nothing extra. The cart, booking, or experience in the path identifies the record.
Reads the brand only from your key, e.g. Get all listings, Get featured listings, or Get hosts	A `Way-Brand-Id: [Brand ID]` header. Without it the request fails with `404 Not Found`.
Works organization-wide, e.g. Get bookings	Nothing extra returns every brand in the organization. Add `Way-Brand-Id` to narrow it to one brand.

A brand key never needs the header: it already names its brand, and a Way-Brand-Id header sent with one is ignored. Requests for a brand or resource outside the key’s organization fail with 403 Forbidden.

Example: list the brands in your organization

curl \
     -X GET \
     -H "Authorization: Bearer [Your Organization API Key]" \
     -H "Content-Type: application/json" \
     https://api.letsway.com/v1/organizations/[Your Organization ID]/brands

If successful, you will receive a response that looks like the following:

{
  "items": [
      {
        "id": "b91e63ed-026c-4bd1-ae92-c910f20b9aa0",
        "name": "The City Hotel",
        "tier": "growth",
        "countryCode": "US",
        "currency": "USD",
        "isTestBrand": false,
        "organizationId": "94a6fbf3-586f-42fb-b52a-90fa962bc4d7",
        "products": [
            "host",
            "activate",
            "reserve"
        ]
    }
  ]
}

Get started

Guides

Create an API key

Key format

Verify your credentials

Brand keys and organization keys

Naming a brand with an organization key

​Create an API key

​Key format

​Verify your credentials

​Brand keys and organization keys

​Naming a brand with an organization key

Create an API key

Key format

Verify your credentials

Brand keys and organization keys

Naming a brand with an organization key