Quickstart

This guide takes you from zero to your first successful API response: your brand’s live listings, fetched with your own credentials.

Prerequisites

Access to the Way dashboard for your brand.
API access enabled for your brand. If you don’t see Settings → Developers in the dashboard, ask your Way representative to enable it.

Create an API key

In the Way dashboard, go to Settings → Developers → API Keys, select Create API key, name the key, and choose Secret key. Copy the key - it looks like way_sk_live_bMQ8BHPjMQX_97rJKxAVjkg.

Creating a new API key in the Way dashboard

Also note the Brand ID shown on the same page - the key already identifies your brand, but some endpoint URLs include it as a path segment.

A secret key must only be used from your server. Never embed it in client-side code or expose it to end users - for browser use, create a publishable key instead.

Using an organization key instead

If you manage multiple brands, one organization key (Organizations → API Keys in the dashboard) covers all of them: send it on its own for organization-scoped endpoints and for brand-scoped endpoints whose resource is in the URL path, or add a Way-Brand-Id header to scope a request to one brand. See Authentication for the details.

Using an older Way-Secret-Key credential

Keys issued before the way_ format are sent as Way-Brand-Id + Way-Secret-Key headers and keep working. See Legacy authentication.

Fetch your listings

Every request is authenticated with a single header: Authorization: Bearer <your API key>.

Try it in your browser

Open this endpoint in the interactive playground - paste your API key into the authorization field, pick the server, and hit Send. No code needed.

A successful response contains your brand’s published listings:

{
  "items": [
    {
      "id": "1f4877f4-a082-4a05-9cbf-fa129b28f01c",
      "title": "Sunset Sailing Tour",
      "kind": "EXPERIENCE",
      "startingPrice": 8900,
      "brandCurrency": "USD"
    }
  ],
  "meta": { "itemCount": 1, "totalItems": 12, "currentPage": 1 }
}

These are the listings your integration can display and take bookings for.

“Listings” are your experiences, packaged for display. A listing is how an experience appears on the storefront - title, photos, price - while the experience behind it (sessions, capacity, pricing) is the item actually being booked, referenced by experienceId. This endpoint returns the display catalog; Get experiences returns the underlying records. See Introduction.

The same call in JavaScript

const response = await fetch("https://api.letsway.com/v3/listings", {
  headers: {
    Authorization: `Bearer ${process.env.WAY_API_KEY}`,
  },
});
const { items } = await response.json();

Troubleshooting

401 Unauthorized

The key is wrong, or it belongs to the other environment - way_sk_live_ keys only work against production and way_sk_test_ keys against staging. Check you’re calling the base URL that matches your key. See Environments.

403 Forbidden

API access isn’t enabled for your brand or organization (contact your Way representative) - or the key doesn’t cover what you addressed: a brand key used against another brand’s URL, an organization key scoped to a brand outside that organization, or a publishable key used from a domain that isn’t approved.

Empty items array

Your brand has no published listings. Publish at least one listing in the dashboard, or query staging where your test data lives.

Prerequisites

Try it in your browser

Troubleshooting

Next steps

Authentication

Build a booking integration

​Prerequisites

Try it in your browser

​Troubleshooting

​Next steps

Authentication

Build a booking integration

Prerequisites

Troubleshooting

Next steps