melonly logomelonly logo
melonly logo
Dashboard
Log in

List Records

Lists records, such as citations, arrests and reports, newest first.

GET

/api/v1/server/cad/records

Request

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

Response

200

Success

{
  "data": [
    {
      "agency": {},
      "createdAt": 1794776859830,
      "createdByUnit": {},
      "createdByUserId": "7308965405773533184",
      "data": {},
      "flags": [],
      "id": "7527000000000000002",
      "label": "Citation",
      "meta": {},
      "noCharge": false,
      "objects": [],
      "previewData": {},
      "serverId": "7294057520392310784",
      "status": 0,
      "templateId": 1,
      "type": 0
    }
  ],
  "page": 1,
  "pageSize": 10,
  "total": 1,
  "totalPages": 1
}

You can order by createdAt (default) or id.

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.

createdAtintegerrequired
When it was created.
createdByUserIdstringrequired
Melonly user ID of who created the record.
dataobjectrequired
Record contents.
flagsobjectrequired
Flags set on the record.
idstringrequired
Unique ID.
labelstringrequired
Record label.
metaobjectrequired
Extra record metadata.
objectsobjectrequired
People, vehicles and other objects in the record.
previewDataobjectrequired
Summary shown in lists.
serverIdstringrequired
Server ID.
statusintegerrequired
Status code.
templateIdintegerrequired
Record template ID.
typeintegerrequired
Type code.
agencyobject | null
Agency that created it.
createdByUnitobject | null
Unit that created the record.
noChargeboolean | null
Whether charges were dropped.

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