Skip to content
GET/api/v1/white-label

Get white-label configuration

Returns the white-label config for the caller's org (resolved from their org_members row, additionally pinned to the authenticating API key's own org): customDomain, logoUrl, faviconUrl, primaryColor, accentColor, backgroundColor, companyName, supportEmail, customCss, hideEvalGuardBranding, loginMessage, welcomeMessage, updatedAt. When no config row exists yet it returns defaults (primaryColor #7C3AED, accentColor #A78BFA, companyName 'EvalGuard', hideEvalGuardBranding false); 404 when the caller has no org. NOT plan-gated on this path — no requiredPlan or requiredFeature is declared and no org extractor is set, so the entitlement gate never runs, even though the surface is marketed as Enterprise. Note the stored branding is persisted only; no page currently renders it.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/settings/api-keys.

Response

200 example

{
  "success": true
}

All status codes

200Config.
400(no description)
401(no description)
403Forbidden — insufficient role for this operation.
404Not Found.
429(no description)
500Internal Server Error — an unhandled error was converted to the standard error envelope (INTERNAL_ERROR).

Code samples

cURL

curl -X GET \
  https://evalguard.ai/api/v1/white-label \
  -H "Authorization: Bearer $EVALGUARD_API_KEY"

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:

const res = await fetch("https://evalguard.ai/api/v1/white-label", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}` },
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}

response = requests.request("GET", "https://evalguard.ai/api/v1/white-label", headers=headers)
print(response.status_code, response.json())

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequestWithContext(context.Background(), "GET", "https://evalguard.ai/api/v1/white-label", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403404429500

Other Admin endpoints