v1

latestOpenAPI 3.0.12026-08-061638881007.6 KB
Accounts

Retrieve all generated addresses

get/v1/domains/{domainId}/accounts/{accountId}/addresses

Path parameters

domainIdstring uuid required

Unique identifier for the domain.

accountIdstring uuid required

Query parameters

limitinteger

The number of entities to return.

startingAfterstring uuid

AccountAddressId id used to the determine beginning of query results.

sortBy'id' | 'ledgerId' | 'address' | 'createdAt' | 'scope'

Property name used to sort the query results.

sortOrder'ASC' | 'DESC'

Sort order applied to the query results.

ledgerIdstring[]

Return addresses matching given ledgers.

lastOnlyboolean

Return only last addresses for matching ledgers.

scopeCoreAccountAddressScope[]

Return addresses matching given scopes.

Response

countinteger required
currentStartingAfterstring
nextStartingAfterstring

Example response

{
  "items": [
    {
      "data": {
        "scope": "External"
      },
      "scope": "External"
    }
  ]
}