List shared assets

GET

https://your-protect-instance.example.com/api/rest/v1/tn/shared_assets

GET

/api/rest/v1/tn/shared_assets

curl https://your-protect-instance.example.com/api/rest/v1/tn/shared_assets \
     -H "Authorization: Bearer <token>"

{
  "sharedAssets": [
    {
      "id": "string",
      "wlContractAddressID": "string",
      "ownerParticipantId": "string",
      "targetParticipantId": "string",
      "blockchain": "string",
      "network": "string",
      "name": "string",
      "symbol": "string",
      "decimals": "string",
      "contractAddress": "string",
      "tokenId": "string",
      "kind": "string",
      "originCreationDate": "2024-01-15T09:30:00Z",
      "originDeletionDate": "2024-01-15T09:30:00Z",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "targetAcceptedAt": "2024-01-15T09:30:00Z",
      "targetRejectedAt": "2024-01-15T09:30:00Z",
      "status": "string"
    }
  ],
  "cursor": {
    "currentPage": "string",
    "hasPrevious": true,
    "hasNext": true
  }
}

This endpoint returns a list of whitelisted assets that you shared or that are shared to you via Taurus Network. You can filter the results by specifying the owner or the target of the shared assets.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

participantIDstringOptional

Get all the shared assets where the participantID is either the owner or the target of the shared assets.

ownerParticipantIDstringOptional

Filter shared assets by specifying who is the owner of the shared assets (your participant or the counterparty)

targetParticipantIDstringOptional

Filter shared assets by specifying who is the target of the shared assets (your participant or the counterparty)

blockchainstringOptional

Filter shared assets by specifying the blockchain of the shared assets

networkstringOptional

Filter shared assets by specifying the network of the shared assets. It must be used in combination with the blockchain filter.

idslist of stringsOptional

Filter shared addresses by specifying the shared asset IDs

sortOrderstringOptional

Set this parameter to ASC to get the id sorted in ASC order or DESC to get them in descending order. By default, the order is DESC.

cursor.currentPagestringOptional

Base64-encoded string representing the current window of data

cursor.pageRequeststringOptional

The page to request, w.r.t the current page. Can be one of FIRST, PREVIOUS, NEXT, LAST

cursor.pageSizestringOptionalformat: "uint64"

The size of the page requested. The handling service should impose a hard limit on this

statuseslist of stringsOptional

Filter shared assets by specifying a list of statuses. Accepted status values: 'new', 'pending', 'rejected', 'accepted', 'unshared'

Response

A successful response.

sharedAssetslist of objectsOptional

cursorobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error