OCocoya
Account

List all owned brands

Changed on

Returns a short summary of every owned brand: name, website and brand score. Get the full profile with GET /brands/{brandId}.

get/brands

Request

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

Response

Success

idstring required

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

namestring nullable required

Brand name.

imagestring nullable required

Brand avatar URL.

timezonestring nullable required

Brand timezone.

urlstring required

Brand website, or an empty string.

userCountinteger required

Number of team members in the brand.

scoreinteger required

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 response

[
  {
    "id": "cmayvq3hk00017apshay5qezu",
    "name": "Ocoya",
    "timezone": "Europe/London",
    "url": "https://www.ocoya.com",
    "userCount": 3,
    "score": 75
  }
]

Changes

  • ef9bd3530850Revision changes
    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • ad0d7f3cdd9bRevision changes
    • info

      api operation id listBrands was added

    • info

      api tag Account added

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status