melonly logomelonly logo
melonly logo
Dashboard
Log in

List Unit Groups

Lists your unit groups.

GET

/api/v1/server/cad/unit-groups

Request

curl -X GET "https://api.melonly.com/api/v1/server/cad/unit-groups" \
  -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": []
    }
  ],
  "page": 1,
  "pageSize": 10,
  "total": 1,
  "totalPages": 1
}

Authorization

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

Query parameters

pageintegerdefault: 1
1-based page number. Defaults to 1.
pageSizeintegerdefault: 10
Items per page, clamped to 1-100. Defaults to 10.
orderBystring
Field to sort by. See the endpoint description for the accepted values.
sortstring
Sort direction. Defaults to desc.
Allowed values:ascdesc

Response

200 Success. Results are paged and also include page, pageSize, total and totalPages.

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
404CAD is not set up
429Rate limited. See Retry-After and details.
500Internal server error