login-portals

Changed on

Get a login portal

get/login-portals/{slug}

Request

  • Base URL
    https://api.scalar.com/core
  • URL
    https://api.scalar.com/core/login-portals/{slug}
  • Auth
    HTTP bearer

Path parameters

slugstring required

Response

Default Response

uidstring required
titlestring required
slugstring required

Example response

{
  "uid": "UakgbKJ5m9gl0JDMbcJqL",
  "title": "Acme API",
  "slug": "acme-api",
  "email": {
    "logo": "<img src=\"https://example.com/logo.svg\" alt=\"Acme\" />",
    "logoSize": "100",
    "buttonText": "Access documentation",
    "message": "Click to access Acme private API documentation.",
    "title": "Acme API",
    "mainColor": "#1f2937",
    "mainBackground": "#f9fafb",
    "cardColor": "#1f2937",
    "cardBackground": "#ffffff",
    "buttonColor": "#ffffff",
    "buttonBackground": "#2563eb"
  },
  "page": {
    "title": "Acme API",
    "description": "Sign in with your work email to access Acme documentation.",
    "head": "<meta name=\"robots\" content=\"noindex\" />",
    "script": "document.documentElement.dataset.company = \"acme\";",
    "theme": "TakgbKJ5m9gl0JDMbcJqL",
    "companyName": "Acme",
    "logo": "<img src=\"https://example.com/logo.svg\" alt=\"Acme\" />",
    "logoURL": "https://example.com",
    "favicon": "https://example.com/favicon.ico",
    "termsLink": "https://example.com/terms",
    "privacyLink": "https://example.com/privacy",
    "formTitle": "Sign in to Acme Documentation",
    "formDescription": "Sign in with your work email to access Acme documentation.",
    "formImage": "https://example.com/login-banner.png"
  }
}

Changes