GET
/api/v1/server/cad/records
Request
Response
200
Success
You can order by createdAt (default) or id.
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.
createdAtintegerrequiredWhen it was created.
createdByUserIdstringrequiredMelonly user ID of who created the record.
dataobjectrequiredRecord contents.
flagsobjectrequiredFlags set on the record.
idstringrequiredUnique ID.
labelstringrequiredRecord label.
metaobjectrequiredExtra record metadata.
objectsobjectrequiredPeople, vehicles and other objects in the record.
previewDataobjectrequiredSummary shown in lists.
serverIdstringrequiredServer ID.
statusintegerrequiredStatus code.
templateIdintegerrequiredRecord template ID.
typeintegerrequiredType code.
agencyobject | nullAgency that created it.
createdByUnitobject | nullUnit that created the record.
noChargeboolean | nullWhether charges were dropped.
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 |