STstellar
Organization

Get All Assets

Changed on

Fetches the list of available assets to populate the dropdown box in the New Disbursement flow. Note: the organization must hold a balance in a particular asset to use it in a disbursement.

get/assets

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Query parameters

enabledboolean

When set, each asset also reports whether the selected distribution account can send it and what it currently holds. true returns only assets the account is set up for, false only those it is not.

Headers

X-Wallet-Idstring

Optional. When the enabled filter is used, selects the distribution account that the enabled and balance fields describe. Omit it to describe the tenant's default account.

Response

A list of assets. When the enabled filter is used, each entry also carries enabled and balance.

Example response

[
  {
    "id": "ffaec4b3-46b0-4db4-a4c4-6c3508057705",
    "code": "USDC",
    "issuer": "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
    "created_at": "2023-02-03T10:45:51Z",
    "updated_at": "2023-02-03T10:45:51Z",
    "deleted_at": "2023-06-03T10:55:51Z"
  }
]

Changes

  • 7588d8d2a3c7Revision changes
    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional header request parameter X-Wallet-Id

    • info

      added the new optional query request parameter enabled

    • info

      added the non-success response with the status