GET
https://www.app.ocoya.com/api/_public/v1/brands
List all owned brands
curl --request GET \
  --url https://www.app.ocoya.com/api/_public/v1/brands \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "cmayvq3hk00017apshay5qezu",
    "name": "Ocoya",
    "image": null,
    "timezone": "Europe/London",
    "url": "https://www.ocoya.com",
    "userCount": 3,
    "score": 75
  }
]

Authorizations

X-API-Keystringheaderrequired

Your API key. Create one in Ocoya. Authorization: Bearer <key> works too.

Response

application/json

Success

object[]
idstring

Brand ID. Pass it as brandId to brand-scoped endpoints.

Example:"cmayvq3hk00017apshay5qezu"
namestring | null

Brand name.

Example:"Ocoya"
imagestring | null

Brand avatar URL.

timezonestring | null

Brand timezone.

Example:"Europe/London"
urlstring

Brand website, or an empty string.

Example:"https://www.ocoya.com"
userCountinteger

Number of team members in the brand.

Example:3
scoreinteger

Brand score out of 100, as the app's sidebar shows it. The full profile and the next step are on GET /brands/{brandId}.

Example:75