GET
/
groups
cURL
curl --request GET \
  --url https://api.crunchz.app/api/groups \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "<string>",
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "created_at": "<string>",
      "owner": "<string>",
      "restricted": true,
      "is_community": true,
      "is_owner": true,
      "actions": {
        "join_approval": true,
        "can_add_member": true
      },
      "participant_count": 123
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 50,
    "total": 150,
    "total_pages": 3,
    "has_next_page": true,
    "has_prev_page": false
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:50

Limit (optional, default: 50, min: 1, max: 100)

Required range: 1 <= x <= 100
offset
integer
default:0

Offset (optional, default: 0, min: 0)

Required range: x >= 0

Response

200
application/json

GroupsCollection

The response is of type object.