Skip to Content
TTConnect public documentation
APIEndpoints

Endpoints

A high-level overview of the main API areas. Exact paths and request/response shapes depend on your API version—use the base path /api/v1 and refer to any OpenAPI or Postman collection your team provides for full detail.

Health

  • GET /health — Basic health check.
  • GET /health/ready — Readiness (e.g. DB and dependencies).
  • GET /health/live — Liveness probe.

No authentication required for health endpoints.

Auth

  • POST /auth/login — Log in with email/password; returns JWT.
  • GET /auth/verify — Verify current JWT.
  • POST /auth/refresh — Refresh JWT.
  • POST /auth/logout — Log out.
  • GET /auth/api-keys — List API keys (JWT required).
  • POST /auth/api-keys — Create API key (JWT required).

Additional auth endpoints may exist for registration, wallet login, and API key CRUD.

Tenants and stores

  • GET /tenants/public — Public tenant/brand info.
  • GET /tenants/public/:subdomain — Public info by subdomain.
  • GET /stores/tenant/:tenantId — List stores for a tenant.
  • GET /stores/tenant/:tenantId/default — Default store for a tenant.

Memberships and products

  • GET /memberships/user — Current user’s memberships.
  • GET /tenants/:tenantId/membership/status — Membership status for tenant.
  • GET /tenants/:tenantId/user/products — User’s products.
  • POST /tenants/brand/products — Create/update products (admin).

Payments

  • POST /payments/create — Create a payment.
  • GET /payments/status/:trackingId — Check payment status.
  • POST /payments/refund/:paymentId — Request a refund.

Crypto-specific endpoints exist for creating crypto payments, getting quotes, and updating status.

Stripe (card payments)

  • POST /stripe/intent — Create payment intent.
  • POST /stripe/subscribe — Create subscription.
  • POST /stripe/coupons/validate — Validate a coupon.
  • POST /stripe/webhook — Incoming Stripe webhooks (used by Stripe, not by you directly).

Coupons

  • GET /coupons/public/:tenantId — Public coupon list.
  • POST /coupons/:tenantId — Create coupon (admin).
  • GET /coupons/:tenantId/:couponId/eligibility — Check eligibility.
  • POST /coupons/:tenantId/:couponId/claim — Claim coupon.

Quests

  • GET /quests/tenant/:tenantId — List quests.
  • POST /quests/tenant/:tenantId — Create quest (admin).
  • POST /quests/tenant/:tenantId/:questId/daily/claim — Claim daily quest.

Referrals

  • GET /referrals/verify — Verify referral link.
  • POST /referrals/track — Track referral event.
  • GET /referrals/brand/analytics — Referral analytics (admin).
  • POST /referrals/user/links — Get or create user referral links.

Storage

  • POST /storage/upload — Upload file.
  • POST /storage/presigned-url — Get presigned upload URL.
  • GET /storage/url/:key — Get download URL for a file.

For authentication details see Authentication. For errors and limits see Errors and limits.

Last updated on
AuthenticationWebhooks