Skip to main content
GET
Retrieve chain of custody by APK ID
The apkId path parameter is the internal asset APK ID used by Retrieve Asset. It differs from the asset detail row’s id. Authenticate using the API key generated in Admin → My Preferences → API Key Configuration. The asset must belong to the subscriber associated with that key. Do not supply subscriberId or combine the APK ID with another asset selector.
This route supports the same date, search, performed-by, movement type, and sorting parameters as Chain of Custody by Identifier. Both return the same report envelope and have the same 10,000-row limit. Retrieving the report does not perform a transfer or update inventory.

Path Parameters

apkId
integer<int32>
required

Internal asset APK ID. Do not combine with ezyid, serialNumber or customId.

Required range: x >= 1

Query Parameters

apiKey
string
required

API key generated in Admin > My Preferences > API Key Configuration. The subscriber is read from this key; do not supply subscriberId.

fromDate
string<date>

Inclusive start date. Must be on or before toDate when both are supplied.

toDate
string<date>

Inclusive end date.

Search text for the chain of custody report.

performedBy
string

Comma-separated names to filter the report.

custodyMovementTypes
string

Comma-separated, case-insensitive substrings of event type names, for example transfer,checkout.

sortColumn
string
default:date

Column to sort by. Defaults to date. Supported canonical keys: date, assetname, category, assetid, partnumber, serialnumber, customid, site, movementtype, performedby, details, eventid.

sortDesc
boolean
default:false

Use true for descending order.

Response

Chain of custody report. Returns at most 10,000 rows with page 1 and pageSize 10000; these endpoints do not expose paging parameters.

data
object[]
totalCount
integer<int32>

Total count reported by the inventory service.

page
integer
Example:

1

pageSize
integer

The internal report row limit. No page or pageSize query parameters are exposed.

Example:

10000