GET/hyax-api/v1/community/settings

Get community access settings

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Request examples

Same request in cURL, Node.js (fetch), and PHP (ext-curl).

curl -X GET 'https://platform.hyax.com/hyax-api/v1/community/settings' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": {
    "accessType": "PAID",
    "requiredProducts": [{ "id": "clx…", "title": "Pro Course", "type": "COURSE", "pricingType": "SINGLE" }],
    "requiredMembershipPlans": [{ "id": "clx…", "name": "Pro", "status": "ACTIVE" }]
  }
}