Responses

  • 200 application/json

    Groups retrieved successfully

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • data array[object]
      Hide data attributes Show data attributes object
      • jid string
      • name string
      • participant_count integer
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • error string
  • 500 application/json

    Internal server error

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • error string
GET /groups
curl \
 --request GET 'http://localhost:7001/groups' \
 --header "Authorization: $API_KEY"
Response examples (200)
{
  "code": 200,
  "data": [
    {
      "jid": "120363123456789012@g.us",
      "name": "My Group",
      "participants": [
        {
          "jid": "6281234567890@s.whatsapp.net",
          "is_admin": true,
          "is_super_admin": true
        },
        {
          "jid": "6289876543210@s.whatsapp.net",
          "is_admin": false,
          "is_super_admin": false
        }
      ],
      "participant_count": 25
    },
    {
      "jid": "120363123456789013@g.us",
      "name": "Work Team",
      "participants": [
        {
          "jid": "6281234567890@s.whatsapp.net",
          "is_admin": true,
          "is_super_admin": false
        }
      ],
      "participant_count": 10
    }
  ],
  "status": true,
  "message": "Groups retrieved successfully"
}
Response examples (200)
{
  "status": true,
  "code": 200,
  "message": "Groups retrieved successfully",
  "data": [
    {
      "jid": "120363123456789012@g.us",
      "name": "My Group",
      "participant_count": 25
    }
  ]
}
Response examples (401)
{
  "code": 401,
  "error": "Invalid or expired JWT token",
  "status": false,
  "message": "Unauthorized"
}
Response examples (401)
{
  "status": false,
  "code": 401,
  "message": "Unauthorized",
  "error": "Invalid or missing authentication"
}
Response examples (500)
{
  "code": 500,
  "error": "Failed to retrieve groups",
  "status": false,
  "message": "Internal server error"
}
Response examples (500)
{
  "status": false,
  "code": 400,
  "message": "Bad request",
  "error": "Bad request"
}