v1

latestOpenAPI 3.0.02026-08-063014193.1 MB

Safe Custody Packets

Return the data for all SafeCustodyPackets

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

get/safe_custody/packets.json

contact_idinteger

Filter SafeCustodyPacket records to those held on behalf of the contact with the given ID.

created_sincestring date-time

Filter SafeCustodyPacket 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 SafeCustodyPacket records to those having the specified unique identifiers.

limitinteger

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

page_tokenstring

A token specifying which page to return.

updated_sincestring date-time

Filter SafeCustodyPacket 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.