melonly logomelonly logo
melonly logo
Dashboard
Log in

Get a Unit Group

Gets one unit group.

GET

/api/v1/server/cad/unit-groups/{groupId}

Request

curl -X GET "https://api.melonly.com/api/v1/server/cad/unit-groups/{groupId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Success

{
  "data": {
    "id": 3,
    "maxUnits": 4,
    "name": "Adam 1",
    "panic": false,
    "premade": true,
    "serverId": "7294057520392310784",
    "status": 1,
    "units": []
  }
}

Authorization

Authorizationstringrequired
Your API token as Bearer YOUR_TOKEN. Create one in your server's dashboard settings.

Path parameters

groupIdstringrequired

Response

200 Success

idintegerrequired
Unit group ID.
namestringrequired
Display name.
panicbooleanrequired
Whether panic is active.
premadebooleanrequired
Whether it's a premade group.
serverIdstringrequired
Server ID.
statusintegerrequired
Status code.
unitsobjectrequired
Units attached.
customStatusIdstring | null
Custom status, when one is set.
maxUnitsinteger | null
Most units that can join.
restrictAgencystring | null
Only this agency's units can join.

Errors

StatusMeaning
400Invalid request. validation_failed lists each invalid field in details.fields.
401Missing, invalid or expired token
404Not found
429Rate limited. See Retry-After and details.
500Internal server error