Get a login portal
GET
/v1/login-portals/{slug}Features
Get a login portal by slug.
Input1
Your API key, sent as
Authorization: Bearer YOUR_SCALAR_ACCESS_TOKEN.Sent from your browser straight to the API — never to Docsbook, never stored.Output5
Show child attributes11
Show child attributes14
Responses
200Default Response
400Bad request
401No auth
403Forbidden
404Not found
422Invalid payload
500Uncaught error
Example input
curl 'https://access.scalar.com/v1/login-portals/{slug}' \
-H 'Authorization: Bearer YOUR_SCALAR_ACCESS_TOKEN'Example output
{
"uid": "<uid>",
"title": "<title>",
"slug": "<slug>",
"email": {
"logo": "<logo>",
"logoSize": "<logoSize>",
"buttonText": "<buttonText>",
"message": "<message>",
"title": "<title>",
"mainColor": "<mainColor>",
"mainBackground": "<mainBackground>",
"cardColor": "<cardColor>",
"cardBackground": "<cardBackground>",
"buttonColor": "<buttonColor>",
"buttonBackground": "<buttonBackground>"
},
"page": {
"title": "<title>",
"description": "<description>",
"head": "<head>",
"script": "<script>",
"theme": "<theme>",
"companyName": "<companyName>",
"logo": "<logo>",
"logoURL": "<logoURL>",
"favicon": "<favicon>",
"termsLink": "<termsLink>",
"privacyLink": "<privacyLink>",
"formTitle": "<formTitle>",
"formDescription": "<formDescription>",
"formImage": "<formImage>"
}
}