GET
https://www.app.ocoya.com/api/_public/v1/me
Me
curl --request GET \
  --url https://www.app.ocoya.com/api/_public/v1/me \
  --header 'X-API-Key: <api-key>'
{
  "id": "clh49n2u300008kovd2wq1p8z",
  "name": "Jane Doe",
  "email": "jane@example.com",
  "brands": [
    {
      "id": "cmayvq3hk00017apshay5qezu",
      "name": "Ocoya"
    }
  ]
}

Authorizations

X-API-Keystringheaderrequired

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

Response

application/json

Success

idstring

User ID.

Example:"clh49n2u300008kovd2wq1p8z"
namestring | null

User name.

Example:"Jane Doe"
emailstring | null

User email address.

Example:"jane@example.com"
brandsobject[]

Every brand the user owns, the same list as GET /brands.

Show child attributesHide child attributes
brands.idstring

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

Example:"cmayvq3hk00017apshay5qezu"
brands.namestring | null

Brand name.

Example:"Ocoya"