melonly logomelonly logo
melonly logo
Dashboard
Log in

Get a Unit

Gets one unit.

GET

/api/v1/server/cad/units/{unitId}

Request

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

Response

200

Success

{
  "data": {
    "agency": "LSSD",
    "id": 12,
    "items": [],
    "loc": {},
    "location": "Postal 214",
    "name": "Builderman",
    "number": "1A-12",
    "panic": false,
    "rank": "Deputy",
    "serverId": "7294057520392310784",
    "status": 1,
    "subdivision": "Patrol",
    "userId": "7308965405773533184"
  }
}

Authorization

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

Path parameters

unitIdstringrequired

Response

200 Success

agencystringrequired
Agency.
idintegerrequired
Unit ID.
itemsobjectrequired
Equipment carried.
locobjectrequired
Map position.
numberstringrequired
Unit number, such as 1A-12.
panicbooleanrequired
Whether panic is active.
serverIdstringrequired
Server ID.
statusintegerrequired
Status code.
userIdstringrequired
Melonly user ID of who's on the unit.
customStatusIdstring | null
Custom status, when one is set.
locationstring | null
Location text.
namestring | null
Callsign name.
rankstring | null
Rank.
subdivisionstring | null
Subdivision.

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