GET
/
v1
/
tenants
/
me
curl https://api.zquenceeee.com/v1/tenants/me \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
  "name": "Acme Escrow",
  "loginSlug": "acme-escrow",
  "environment": "live",
  "status": "active",
  "branding": {
    "logoKey": "tenants/bc41c6ab-7206-4033-b632-4d1cfa86d840/logo.png",
    "theme": {
      "primaryColor": "#0070FA",
      "secondaryColor": "#4D9DFF",
      "textColor": "#0F172A",
      "backgroundColor": "#FFFFFF",
      "cardBackgroundColor": "#F8FAFC",
      "primaryTextColor": "#FFFFFF",
      "secondaryTextColor": "#64748B"
    }
  },
  "planId": "6a1ea31b892791af056f46bd",
  "plan": {
    "id": "6a1ea31b892791af056f46bd",
    "name": "Growth",
    "currency": "usd",
    "monthlyPrice": 99,
    "annualPrice": 990,
    "durationDays": 30,
    "transactionLimit": 500,
    "usersLimit": 1000,
    "apiCallsPerMonth": 50000
  },
  "subscriptionStatus": "active",
  "subscriptionStart": "2026-01-01T00:00:00.000Z",
  "subscriptionEnd": "2027-01-01T00:00:00.000Z",
  "apiCallsPerMonthLimit": 50000,
  "environmentsLimit": 3
}
Returns the full profile for the tenant associated with the authenticated API key. Includes branding configuration, subscription plan limits, and environment constraints.

​
Returns

​
tenantId
string
Unique tenant identifier (UUID format, e.g. bc41c6ab-7206-4033-b632-4d1cfa86d840).
​
name
string
Display name of the tenant (e.g. "Acme Escrow").
​
loginSlug
string | null
URL-safe login slug used for the tenant’s branded login page (e.g. "acme-escrow"). null if not configured.
​
environment
string
Primary environment mode — "live" or "sandbox".
​
status
string
Tenant account status. One of "active", "inactive", "disabled", "deleted".
​
branding
object
Branding configuration for the tenant’s hosted pages.
​
planId
string | undefined
MongoDB ObjectId of the assigned plan. undefined if no plan is assigned.
​
plan
object | null
Summary of the assigned plan. null if no plan is assigned.
​
subscriptionStatus
string | undefined
Current subscription state — "pending", "active", or "expired". undefined if no subscription is active.
​
subscriptionStart
string | undefined
ISO 8601 UTC timestamp when the subscription started. undefined if not set.
​
subscriptionEnd
string | undefined
ISO 8601 UTC timestamp when the subscription expires. undefined if not set.
​
apiCallsPerMonthLimit
number | undefined
Per-tenant override for the monthly API call limit. When set, this takes precedence over the plan’s apiCallsPerMonth. undefined means the plan limit applies.
​
environmentsLimit
number | undefined
Maximum number of sandbox environments this tenant can create. undefined means no limit beyond the platform default.

​
Error codes

StatusMeaning
400tenantId could not be resolved from the authenticated credential.
401Missing or invalid API key pair.
404The tenant associated with the authenticated credential no longer exists.
curl https://api.zquenceeee.com/v1/tenants/me \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
  "name": "Acme Escrow",
  "loginSlug": "acme-escrow",
  "environment": "live",
  "status": "active",
  "branding": {
    "logoKey": "tenants/bc41c6ab-7206-4033-b632-4d1cfa86d840/logo.png",
    "theme": {
      "primaryColor": "#0070FA",
      "secondaryColor": "#4D9DFF",
      "textColor": "#0F172A",
      "backgroundColor": "#FFFFFF",
      "cardBackgroundColor": "#F8FAFC",
      "primaryTextColor": "#FFFFFF",
      "secondaryTextColor": "#64748B"
    }
  },
  "planId": "6a1ea31b892791af056f46bd",
  "plan": {
    "id": "6a1ea31b892791af056f46bd",
    "name": "Growth",
    "currency": "usd",
    "monthlyPrice": 99,
    "annualPrice": 990,
    "durationDays": 30,
    "transactionLimit": 500,
    "usersLimit": 1000,
    "apiCallsPerMonth": 50000
  },
  "subscriptionStatus": "active",
  "subscriptionStart": "2026-01-01T00:00:00.000Z",
  "subscriptionEnd": "2027-01-01T00:00:00.000Z",
  "apiCallsPerMonthLimit": 50000,
  "environmentsLimit": 3
}