v1

latestOpenAPI 3.0.02026-08-063014193.1 MB

Safe Custody Records

Return the data for all SafeCustodyRecords

Outlines the parameters, optional and required, used when requesting the data for all SafeCustodyRecords

get/safe_custody/records.json

created_sincestring date-time

Filter SafeCustodyRecord records to those having the created_at field after a specific time. (Expects an ISO-8601 timestamp).

fieldsstring

The fields to be returned. See response samples for what fields are available. For more information see the fields section.

ids[]integer

Filter SafeCustodyRecord records to those having the specified unique identifiers.

limitinteger

A limit on the number of SafeCustodyRecord records to be returned. Limit can range between 1 and 200. Default: 200.

packet_idinteger

Filter SafeCustodyRecord records to those belonging to the packet with the given ID.

page_tokenstring

A token specifying which page to return.

state'held' | 'temporarily_removed' | 'removed'

Filter SafeCustodyRecord records by custody state (held, temporarily_removed or removed). Use all to include every state.

updated_sincestring date-time

Filter SafeCustodyRecord records to those having the updated_at field after a specific time. (Expects an ISO-8601 timestamp).

X-API-VERSIONstring

The API minor version. Default: latest version.