Skip to main content
GET
Retrieve chain of custody by asset identifier
Use an API key generated in Admin → My Preferences → API Key Configuration. The subscriber is stored against the key and is resolved automatically; do not pass a subscriber ID. Supply exactly one selector: ezyid, serialNumber, customId, or apkId. Identifiers use exact matches within the key’s subscriber, with surrounding input whitespace trimmed. Matching follows the database’s collation rules. If multiple assets match, the API returns 409 Conflict; use a unique identifier or the asset’s APK ID.

Request examples

To use another selector, replace serialNumber=SN123 with ezyid=EZ123, customId=MY-ASSET-123, or apkId=123. URL-encode identifier values containing spaces or special characters.

Filtering and response

fromDate and toDate use yyyy-MM-dd and include both boundary dates. Optional filters include search, performedBy (comma-separated names), and custodyMovementTypes (comma-separated event type substrings such as transfer,checkout). sortColumn defaults to date; sortDesc defaults to false. The response contains data, totalCount, page, and pageSize. It uses the existing inventory custody report, including purchase and create rows when available. The current report returns at most 10,000 rows, with page: 1 and pageSize: 10000. This endpoint does not expose paging parameters.
This GET endpoint retrieves history. It does not perform a transfer or update inventory.
For the path-based APK ID route, see Chain of Custody by APK ID.

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.

apkId
integer<int32>

Internal asset APK ID. Supply exactly one asset selector.

Required range: x >= 1
ezyid
string

Exact EZYiD match within the key's subscriber. Surrounding whitespace is trimmed. Supply exactly one asset selector.

serialNumber
string

Exact serial number match within the key's subscriber. Surrounding whitespace is trimmed. Duplicate matches return 409.

customId
string

Exact custom ID match within the key's subscriber. Surrounding whitespace is trimmed. Duplicate matches return 409.

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