Retrieve Simplified Brand

Get a lightweight brand profile — just the essentials: domain, title, description, logo, primary color, and industries. Best for high-volume use cases where you don’t need the full payload.

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

Parameters

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

Response Schema

{
  "data": {
    "domain": "linear.app",
    "title": "Linear",
    "description": "The issue tracking tool you'll enjoy using.",
    "logo": "https://linear.app/static/og-image.png",
    "primaryColor": "#5E6AD2",
    "industries": ["Software", "Project Management"]
  },
  "_meta": {}
}

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 { data: brand } = await client.brand.retrieveSimplified({
  domain: 'linear.app',
});
 
console.log(brand.title);         // "Linear"
console.log(brand.primaryColor);  // "#5E6AD2"
console.log(brand.logo);          // logo URL

Python

res = client.brand.retrieve_simplified(domain="linear.app")
brand = res["data"]
 
print(brand["title"])         # "Linear"
print(brand["primaryColor"])  # "#5E6AD2"
print(brand["logo"])

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, description, logo, primaryColor, and industries. No socials, page links, fonts, or context.
  • Ideal for card UIs, avatars, or anywhere you just need the visual identity.
  • The brand must already be cached; this endpoint does not trigger live extraction. If the lookup returns 404, hit /v1/brand/retrieve for that domain first.
  • For the full brand profile, use Retrieve by Domain instead.