GET
https://www.app.ocoya.com/api/_public/v1/inbox/labels
List labels
curl --request GET \
  --url https://www.app.ocoya.com/api/_public/v1/inbox/labels \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "cmhx3w8hd000c7apsd1f0g2h3",
    "name": "Needs follow-up",
    "color": "#fa5252",
    "conversationCount": 3
  }
]

Authorizations

X-API-Keystringheaderrequired

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

Query Parameters

brandIdstringrequired

Ocoya brand ID. Get one from GET /brands.

Example:"cmayvq3hk00017apshay5qezu"

Response

application/json

Success

object[]
idstring
Example:"cmhx3w8hd000c7apsd1f0g2h3"
namestring
Example:"Needs follow-up"
colorstring | null

CSS colour.

Example:"#fa5252"
conversationCountinteger

Conversations that have it, archived ones left out.

Example:3