Account

Returns information about authenticated user, including brands (id and name of every owned brand). Use one of these ids as brandId.

get/me

Request

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

Response

Success

idstring required

User ID.

namestring nullable required

User name.

emailstring nullable required

User email address.

Example response

{
  "id": "clh49n2u300008kovd2wq1p8z",
  "name": "Jane Doe",
  "email": "jane@example.com",
  "brands": [
    {
      "id": "cmayvq3hk00017apshay5qezu",
      "name": "Ocoya"
    }
  ]
}

Changes

    • info

      api operation id getMe 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