OCocoya
Account

Get a brand

Changed on

Returns the brand profile as the Brand page shows it: description, website, logos, colors, fonts, tone of voice, writing guidelines, SEO keywords with search volumes, hashtags, and the brand score with its suggested next step.

get/brands/{brandId}

Request

  • Base URL
    https://www.app.ocoya.com/api/_public/v1
  • Auth
    API key in header X-API-Key

Path parameters

brandIdstring required
Example:cmayvq3hk00017apshay5qezu

Ocoya brand ID. Get one from GET /brands.

Response

Success

idstring required

Brand ID.

namestring nullable required

Brand name.

imagestring nullable required

Brand avatar URL.

timezonestring nullable required

Brand timezone.

weekStartinteger nullable required

First day of the week in the calendar (0 is Sunday).

descriptionstring required

What the brand does, as AI writing reads it.

urlstring required

Website, or an empty string.

logosstring[] required

Logo image URLs.

colorsstring[] required

Brand colors as hex values.

fontsobject required

Heading and body fonts used for designs.

socialsobject required

Social profile links, by network.

tonestring[] required

Tone of voice: up to 3 of Friendly, Professional, Playful, Warm, Bold, Witty, Inspiring, Calm, Expert, Casual.

guidelinesstring required

Extra writing guidelines every AI prompt follows.

hashtagsstring[] required

Hashtags the brand's posts use, lowercase and without the #, up to 200. AI campaigns use them.

channelCountinteger required

Connected channels and stores, as the score counts them.

Example response

{
  "id": "cmayvq3hk00017apshay5qezu",
  "name": "Ocoya",
  "timezone": "Europe/London",
  "weekStart": 1,
  "description": "Ocoya helps small teams plan, create and schedule social posts with AI.",
  "url": "https://www.ocoya.com",
  "logos": [
    "https://cdn.ocoya.com/prod/brand/logo.png"
  ],
  "colors": [
    "#1a1a1a",
    "#ff6b35"
  ],
  "fonts": {
    "heading": {
      "fontFamily": "Actor"
    }
  },
  "socials": {
    "instagram": "https://instagram.com/ocoya"
  },
  "tone": [
    "Friendly",
    "Expert"
  ],
  "guidelines": "Never use exclamation marks.",
  "keywords": [
    {
      "keyword": "social media scheduler",
      "monthlySearches": 1900
    }
  ],
  "hashtags": [
    "socialmedia",
    "smallbusiness"
  ],
  "channelCount": 3,
  "score": {
    "score": 75,
    "nextStep": {
      "section": "keywords",
      "sectionLabel": "SEO keywords",
      "label": "Find more SEO keywords",
      "points": 5
    }
  }
}

Changes