GET
https://www.app.ocoya.com/api/_public/v1/contacts/groups
List contact groups
curl --request GET \
  --url https://www.app.ocoya.com/api/_public/v1/contacts/groups \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "cmwdke1w70043y0k4ffzsa6om",
      "name": "Customers",
      "contacts": 340,
      "subscribed": 322
    }
  ]
}

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

dataobject[]
Show child attributesHide child attributes
data.idstring
Example:"cmwdke1w70043y0k4ffzsa6om"
data.namestring
Example:"Customers"
data.contactsinteger
Example:340
data.subscribedinteger
Example:322