GET
/api/v1/server/cad/unit-groups
Request
Response
200
Success
Authorization
AuthorizationstringrequiredYour API token as
Bearer YOUR_TOKEN. Create one in your server's dashboard settings.Query parameters
pageintegerdefault: 11-based page number. Defaults to 1.
pageSizeintegerdefault: 10Items per page, clamped to 1-100. Defaults to 10.
orderBystringField to sort by. See the endpoint description for the accepted values.
sortstringSort direction. Defaults to
desc.Allowed values:
ascdescResponse
200 Success. Results are paged and also include page, pageSize, total and totalPages.
idintegerrequiredUnit group ID.
namestringrequiredDisplay name.
panicbooleanrequiredWhether panic is active.
premadebooleanrequiredWhether it's a premade group.
serverIdstringrequiredServer ID.
statusintegerrequiredStatus code.
unitsobjectrequiredUnits attached.
customStatusIdstring | nullCustom status, when one is set.
maxUnitsinteger | nullMost units that can join.
restrictAgencystring | nullOnly this agency's units can join.
Errors
| Status | Meaning |
|---|---|
400 | Invalid request. validation_failed lists each invalid field in details.fields. |
401 | Missing, invalid or expired token |
404 | CAD is not set up |
429 | Rate limited. See Retry-After and details. |
500 | Internal server error |