Skip to main content

Platform Open API

Updated May 13, 2026

Query shop, product, order, payout, and membership data through Fourthwall's OAuth-scoped Platform Open API

The Platform Open API gives apps read access to a creator's shop data through a single OAuth-authenticated host. Use it to pull current shop details, products, orders, payouts, and memberships into custom tools, dashboards, or integrations you build on the Developer Platform.

Host and base URL​

All Platform Open API requests use this base URL:

https://api.fourthwall.com/open-api/v1.0/

If you call a different host (for example, the Product Offer Open API host at storefront.fourthwall.com), the request will fail authentication even with a valid token.

Authentication​

The Platform Open API authenticates with an OAuth bearer token. The token itself looks the same as a Product Offer Open API key, but it is issued through the OAuth flow on the Developer Platform and scoped to the endpoints your app requested.

  1. Register an app on the Developer Platform. See Developer Platform: Building Apps and Webhooks.
  2. Generate or manage your key at Settings > For Developers > OpenAPI.
  3. Complete the OAuth flow so the creator grants your app the scopes it needs.
  4. Include the access token in every request using the Authorization header:
Authorization: Bearer YOUR_OAUTH_TOKEN

OAuth scopes​

Each endpoint group is gated by a scope your app requests during OAuth. Creators see and approve these scopes on the consent screen, and Fourthwall only issues tokens for the scopes they accept.

  • Shop scope. Required to read shop profile data through /shops/current.
  • Products scope. Required for product endpoints.
  • Orders scope. Required for order endpoints.
  • Payouts scope. Required for payout endpoints.
  • Memberships scope. Required for membership endpoints.

If your app calls an endpoint outside its granted scopes, the request returns 401. Request only the scopes you actually need so creators see a clear, minimal permissions screen.

Key endpoints​

The most common endpoints are listed below. For full request, response, and field documentation, see the Platform Open API reference.

GET /shops/current​

Returns the shop the OAuth token is issued for. This is the Platform Open API equivalent of /me: use it to identify which shop the request is acting on after a creator authorizes your app.

GET https://api.fourthwall.com/open-api/v1.0/shops/current

GET /products​

Returns products in the shop. Use this when you need richer product data than the read-only Product Offer Open API exposes, or when your app already holds an OAuth token.

GET https://api.fourthwall.com/open-api/v1.0/products

GET /orders​

Returns orders placed in the shop. Use this for fulfillment tools, reporting, or syncing order state into external systems.

GET https://api.fourthwall.com/open-api/v1.0/orders

GET /payouts​

Returns payout records for the shop. Use this for finance dashboards, accounting integrations, or reconciliation tooling.

GET https://api.fourthwall.com/open-api/v1.0/payouts

GET /memberships​

Returns memberships and member data for the shop. Use this for retention reporting, member exports, or syncing membership status to a community platform.

GET https://api.fourthwall.com/open-api/v1.0/memberships

What 401 means on this API​

A 401 Unauthorized response on the Platform Open API points to one of three causes:

  • Wrong host. You sent the request to a different API host. The Platform Open API only answers on api.fourthwall.com/open-api/v1.0/.
  • Missing scope. Your OAuth token does not include the scope required for that endpoint group. Re-run the OAuth flow and request the right scopes.
  • Expired or revoked token. The access token has expired, or the creator revoked your app. Refresh the token using the refresh token from the OAuth flow, or prompt the creator to reauthorize.

Check the response body for the specific error code before assuming the cause.

Compare the three Fourthwall APIs​

Fourthwall exposes three public APIs. Pick the one that matches your use case.

APIHostAuthUse case
Product Offer Open APIstorefront.fourthwall.com/api/Static API key in Authorization: Bearer headerRead-only access to your own published products. Quickest path for catalog reads.
Storefront APIstorefront.fourthwall.com/api/Storefront API tokenBuild a custom headless storefront with products, cart, and checkout redirect.
Platform Open APIapi.fourthwall.com/open-api/v1.0/OAuth bearer token, scoped per endpoint groupApps on the Developer Platform that read shop, product, order, payout, or membership data on a creator's behalf.

For more detail on the other two APIs, see Product Offer Open API and Storefront API.

Frequently asked questions​

Is the Platform Open API the same key as the Product Offer Open API?​

The token format is the same, and both are managed under Settings > For Developers > OpenAPI. The Platform Open API key is OAuth-scoped and tied to an app you registered on the Developer Platform, while the Product Offer Open API key is a static read-only key for your own catalog.

What is the Platform Open API equivalent of /me?​

GET /shops/current. It returns the shop the OAuth token is issued for.

Can I write data through the Platform Open API?​

The endpoint groups listed above are read endpoints. Check the full API reference for the current set of write endpoints and the scopes they require.

How do I refresh an expired token?​

Use the refresh token returned by the OAuth flow against the token endpoint, the same way you exchanged the initial authorization code. See Developer Platform: Building Apps and Webhooks for the full OAuth flow.

Where is the full API reference?​

The complete reference, including every endpoint, request schema, and response field, is at docs.fourthwall.com/api-reference/platform/.

If you have any questions, do not hesitate to contact us at support@fourthwall.com

Was this helpful?