Skip to content
KatalystOS Developers

Getting started

The KatalystOS API is a JSON-over-HTTPS API. Partners use it to connect a loyalty program or pull reports for the restaurants they work with.

Environments

Section titled “Environments”
Environment Base URL Use it for
Sandbox https://dev-api.katalystos.com Development and testing. The Try it console in the API reference sends requests here.
Production https://api.katalystos.com Live restaurant data.

Sandbox and production are separate systems: a token issued for one does not work on the other, and restaurants, cards and ids differ between them.

Get credentials

Section titled “Get credentials”

KatalystOS issues credentials on request. There is no self-service sign-up.

  1. Ask your KatalystOS contact for API access. Say which restaurants you need, which APIs (loyalty, WEDU enrollment, reports), and whether you need sandbox, production or both.

  2. Receive an app-to-app token. KatalystOS creates one token per integration and restaurant, with only the permissions your integration needs:

    Permission Grants
    integration.loyalty The loyalty integration endpoints under /v1/integration/loyalty/
    integration.wedu WEDU enrollment, POST /v1/integration/wedu/loyalty-user/
    cogs-well.view The menu item sales report

  3. Store the token as a secret. It acts on behalf of the restaurant. Keep it on your server; never ship it in a browser or mobile app.

Make your first call

Section titled “Make your first call”

Look up a loyalty card by number in the sandbox:

Terminal window
curl "https://dev-api.katalystos.com/v1/integration/loyalty/card/?number=WD-100234" \
  -H "X-KATALYST-AUTH-TOKEN: $KATALYST_TOKEN"

Every response is JSON with a success flag, and failures come back with HTTP 200 too. Check success, not the status code; see Responses and errors.

{
  "restaurant_timezone": "America/New_York",
  "fingerprint": "b82418952c",
  "success": false,
  "response_at": "11/06/2026 02:15pm",
  "errors": { "number": ["Loyalty card not found."] },
  "bot": "¯\\_(ツ)_/¯"
}

Next steps

Section titled “Next steps”