findBranding
Find a Payload global singleton configuration.
Single source of truth for brand identity, voice, business facts and site identity — READ FIRST when drafting content or answering about the business. Groups: voice (voiceTone, forbiddenTerms, allowedVariants, terminology) · business identity (businessType, served areas, availabilityStatus, pricing — when priceItems exist, quote them and never answer "price on request") · contact + emergencyContact · visual assets (logoLight/logoDark/favicon/defaultOgImage = upload IDs; ready-made URLs in /brand.json as logo_url/og_image_url/…) · imageStyleProfiles = the image-style canon, read it BEFORE generating images (scoping/fallback and prompt guidance are described on the fields; resolve reference-image binaries via brand find/get) · specDocs = brand/styleguide DOCUMENTS as bare upload IDs (logo files, a UI-spec HTML, web-font files). The IDs alone say nothing — resolve them via brand find/get to read filename, description and URL, and consult them when you need the visual canon (spacing, type scale, component look) that the token list does not cover. Editor usage rules often sit in the asset description ("NICHT auf weissem Hintergrund"). · htmlElements snippet templates (ready-made, brand-styled HTML/Markdown to copy and adapt — check here before hand-rolling markup) · aiAgentSystemPrompt (public bot persona, served at /brand.txt + /brand.json) · newsletter signup form copy. Field-level meaning: call getResourceSchema "branding" — fields carry editor descriptions. UPDATE POLICY (human-curated SSoT): change ONLY the specific field(s) you were explicitly asked to change — never bulk-rewrite, never "improve" neighboring fields. Many fields are localized: write per target locale, sequentially (one locale per call). branding global (singleton). Public read: yes via /api/agents/global. MCP capabilities: find, update. Fields: logoLight (upload: brand|media), logoDark (upload: brand|media), logoSquare (upload: brand|media), favicon (upload: brand|media), defaultOgImage (upload: media|brand), separator, specDocs (upload: brand), imageStyleProfiles (array), htmlElements (array), addressing (enum: du (You (informal))|sie (You (formal))), companyName, legalName, siteName (localized, required), tagline (localized), allowedVariants (textarea), responsiblePerson, founders (rel-array: team), shortDescription (localized), longDescription (richText, localized), vision (textarea, localized), values (textarea, localized), targetAudience (textarea, localized), usps (textarea, localized), notOffered (textarea, localized), voiceTone (enum-array: professional|casual|matter-of-fact|heartfelt|technical|clear|+21), voiceDescription (textarea, localized), forbiddenTerms (textarea, localized), exampleQuotes (textarea, localized), terminology (textarea, localized), industry (localized), businessType (enum-array: Electrician|Plumber|HVACBusiness|HousePainter|RoofingContractor (Roofing Contractor (roofer, roof repair))|GeneralContractor|+63), foundingYear (number), teamSize (localized), location (localized), softwareApplication (group), serviceRadiusKm (number, ≥0), servedAreas (textarea, localized), servedPostalCodes (textarea), availabilityStatus (enum: accepting (Accepting new clients)|limited (Limited capacity)|waitlist|notAccepting), availabilityNote (textarea, localized), priceItems (array), priceRange, priceNote (textarea, localized), brands (textarea), partners (textarea), certificates (textarea, localized), spokenLanguages (textarea), brandOs (richText, localized), vatId, taxId, chamberOfCommerce, reaNumber, shareCapital (localized), sdiCode, pecEmail, hostingProvider (textarea, localized), mailProvider (textarea, localized), storageProvider (textarea, localized), paymentMethods (localized), paymentTerms (number), jurisdiction (localized), email, phone, address (textarea, localized), emergencyContact (group), geoLatitude (number, -90–90), geoLongitude (number, -180–180), bookingUrl, bookingCtaText (localized), bookingNote (localized), whatsappUrl, contactMessage (textarea, localized), socialLinks (textarea), contactPage (rel: pages), aboutPage (rel: pages), weekly (array), businessHoursNote (textarea, localized), formsSubmitDefault (localized), formsSubmitting (localized), formsSelectPlaceholder (localized), formsThankYouHeadline (localized), formsThankYouBody (textarea, localized), formsGenericError (localized), enabled (boolean), checkboxLabel (localized), pendingNote (localized), alreadyActiveNote (localized), aiAgentSystemPrompt (textarea, localized), aiCatalogQueries (textarea, localized), aiSeoRules (textarea), internalLinkRules (array), internalLinkExclusions (rel-array: pages|glossary|jobs|posts|team), internalLinkMaxSuggestions (number, 1–20).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| depth | No | Depth of population for relationships | |
| locale | No | Optional: locale code to retrieve data in (e.g., "en", "es"). Use "all" to retrieve all locales for localized fields | |
| select | No | Optional: define exactly which fields you'd like to return in the response (JSON), e.g., '{"title": true}' | |
| fallbackLocale | No | Optional: fallback locale code to use when requested locale is not available |