API Reference
Brand Intelligence
Retrieve Simplified

Retrieve Simplified Brand

Get a lightweight brand profile — just the essentials: domain, title, colors, logos, and backdrops. Faster and cheaper than the full retrieve endpoint.

Endpoint: GET /v1/brand/retrieve-simplified Credits: 5 per request

Parameters

ParameterTypeRequiredDescription
domainstringYesDomain to look up (e.g., linear.app)

Response Schema

{
  "success": true,
  "data": {
    "domain": "linear.app",
    "title": "Linear",
    "colors": ["#5E6AD2", "#FFFFFF", "#F7F8F8"],
    "logos": [
      {
        "url": "https://cdn.orsa.dev/logos/linear-icon.svg",
        "type": "svg",
        "theme": "light",
        "width": 64,
        "height": 64
      }
    ],
    "backdrops": [
      "https://cdn.orsa.dev/backdrops/linear-hero.webp"
    ]
  },
  "cached": false,
  "credits_used": 5,
  "request_id": "d4e5f6a7-b8c9-0123-def0-234567890123"
}

Code Examples

cURL

curl -X GET "https://api.orsa.dev/v1/brand/retrieve-simplified?domain=linear.app" \
  -H "Authorization: Bearer YOUR_API_KEY"

TypeScript

const brand = await client.brand.retrieveSimplified({
  domain: 'linear.app',
});
 
console.log(brand.title);     // "Linear"
console.log(brand.colors);    // ["#5E6AD2", "#FFFFFF", "#F7F8F8"]
console.log(brand.logos[0].url);

Python

brand = client.brand.retrieve_simplified(domain="linear.app")
 
print(brand.title)     # "Linear"
print(brand.colors)    # ["#5E6AD2", "#FFFFFF", "#F7F8F8"]
print(brand.logos[0].url)

Error Codes

CodeStatusDescription
INPUT_VALIDATION_ERROR400Invalid or missing domain
UNAUTHORIZED401Missing or invalid API key
NOT_FOUND404No brand data found for the domain
RATE_LIMITED429Rate limit exceeded
USAGE_EXCEEDED402Insufficient credits

Notes

  • Returns only: domain, title, colors, logos, and backdrops. No socials, fonts, industry, or metadata.
  • 2x cheaper than the full retrieve endpoint (5 credits vs 10).
  • Ideal for card UIs, avatars, or anywhere you just need the visual identity.
  • Cached responses return instantly (~50ms).
  • If you need the full brand profile, use Retrieve by Domain instead.