GET
/
tenants
/
slug
/
{slug}
curl --request GET \
  --url https://api.pxyz.dev/api/v0/tenants/slug/{slug}
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "publicKey": "<string>",
  "creatorId": "<string>",
  "logoId": "<string>",
  "logoUri": "<string>",
  "iconId": "<string>",
  "iconUri": "<string>",
  "auth": {
    "id": "<string>",
    "tenantId": "<string>",
    "signUpEnabled": true,
    "signInEnabled": true,
    "strategyUsernamePasswordEnabled": true,
    "strategyEmailPasswordEnabled": true,
    "strategyEmailLinkEnabled": true,
    "strategyEmailCodeEnabled": true,
    "strategyPhoneCodeEnabled": true,
    "strategyPhonePasswordEnabled": true,
    "strategyOAuthEnabled": true,
    "strategyAuthenticatorCodeEnabled": true,
    "strategySecurityKeyEnabled": true,
    "passwordsEnabled": true,
    "emailSignInEnabled": true,
    "phoneSignInEnabled": true,
    "usernameSignInEnabled": true,
    "nameRequired": true,
    "emailRequired": true,
    "phoneRequired": true,
    "usernameRequired": true,
    "passwordRequired": true,
    "emailVerificationRequired": true,
    "phoneVerificationRequired": true,
    "emailVerificationCodeEnabled": true,
    "emailVerificationLinkEnabled": true,
    "phoneVerificationCodeEnabled": true,
    "sessionMaximumLifetimeEnabled": true,
    "sessionMaximumLifetime": 123,
    "sessionInactivityTimeoutEnabled": true,
    "sessionInactivityTimeout": 123,
    "homeUri": "<string>",
    "frontendApiUri": "<string>",
    "signUpUri": "<string>",
    "signInRedirectUri": "<string>",
    "signInUri": "<string>",
    "signUpRedirectUri": "<string>",
    "logoutRedirectUri": "<string>",
    "userSettingsUri": "<string>",
    "organizationSettingsUri": "<string>",
    "createOrganizationUri": "<string>",
    "createOrganizationRedirectUri": "<string>",
    "emailChannelId": "<string>",
    "smsChannelId": "<string>",
    "codeVerificationEmailTemplateId": "<string>",
    "codeVerificationSMSMessageTemplateId": "<string>",
    "magicLinkEmailTemplateId": "<string>",
    "magicLinkSMSMessageTemplateId": "<string>",
    "welcomeEmailTemplateId": "<string>",
    "welcomeSMSMessageTemplateId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "brand": "<any>",
  "environment": "development",
  "domains": [
    {
      "primary": true,
      "name": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

slug
string
required

Response

200 - application/json
id
string
required
name
string
required
slug
string
required
publicKey
string
required
creatorId
string | null
logoId
string | null
required
logoUri
string | null
required
iconId
string | null
required
iconUri
string | null
required
auth
object | null
brand
any
environment
enum<string>
required
Available options:
development,
staging,
production
domains
object[]
required
createdAt
string
required
updatedAt
string
required