Skip to main content

Group API

POST /group​

Description​

This API endpoint retrieves details of a specific group based on the provided ID.

Request Body​

The request utilizes GraphQL to perform the group query with the group ID as a variable.

Query:​

query group ($id: Int) {
    group (id: $id) {
        id
        name
        description
        tagName
        duration
        price
        usernamePostfix
        usernamePostfixId
        dailyBandwidth
        multiLoginCount
        downloadUpload
        ip
    }
}

GraphQL Variables:​

{
  "id": 0
}

Example Request:​

curl --location '' \
--header 'Content-Type: application/json' \
--data '{"query":"query group ($id: Int) {\n    group (id: $id) {\n        id\n        name\n        description\n        tagName\n        duration\n        price\n        usernamePostfix\n        usernamePostfixId\n        dailyBandwidth\n        multiLoginCount\n        downloadUpload\n        ip\n    }\n}","variables":{"id":0}}'

Response:​

  • Success (200 OK):

    • The response includes the details of the specified group.
    {
      "data": {
        "group": {
          "id": 1,
          "name": "Gold Package",
          "description": "Premium package with extended features",
          "tagName": "Gold",
          "duration": 365,
          "price": 199.99,
          "usernamePostfix": "GoldUser",
          "usernamePostfixId": 123,
          "dailyBandwidth": 1000,
          "multiLoginCount": 5,
          "downloadUpload": "Unlimited",
          "ip": "192.168.1.1"
        }
      }
    }

  • Error (4XX/5XX):

    • If there is an issue with retrieving the group details, such as an invalid ID or server error, the response will include an appropriate error message and status code.

Note:​

Ensure the provided id is valid and corresponds to an existing group to receive accurate results.