Skip to content

Get an asset custody

Assets module

GET/asset-custody/{id}assetCustodyEntries.get

An append-only custody ledger entry. Returns one asset custody with its `ETag`. A asset custody the caller may not see returns 404.

  • Requires the capability assets.asset.read.
  • OAuth scopes: assets.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

assetCustodyEntries.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the asset custody.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Response 200: AssetCustody

assetCustodyEntries.get: AssetCustody
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the asset custody.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
asset_unit_idstring (uuid)YesIdentifier of the asset unit.
custodian_membership_idstring (uuid) | nullYesIdentifier of the member who holds the unit.
custodian_engagement_idstring (uuid) | nullYesIdentifier of the external engagement that holds the unit.
venue_idstring (uuid) | nullYesIdentifier of the place the unit is kept.
project_idstring (uuid) | nullYesIdentifier of the project the unit is out for.
notestring | nullYesHand-over note.Constraints: length 0 to 1000
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "asset_unit_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "custodian_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "custodian_engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "note": "Issued for load-in."
}

Code samples

curl -X GET "$XOS_BASE_URL/asset-custody/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.assetCustodyEntries.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.asset_custody_entries.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos asset-custody-entries get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f