Accounts

List accounts

get/v1/domains/{domainId}/accounts

Path parameters

domainIdstring uuid required

Unique identifier for the domain.

Query parameters

limitinteger

The number of entities to return.

startingAfterstring uuid

Entity id used to the determine beginning of query results.

sortBy'id' | 'alias' | 'ledgerId' | 'lock' | 'metadata.createdAt' | 'metadata.lastModifiedAt'

Property name used to sort the query results.

sortOrder'ASC' | 'DESC'

Sort order applied to the query results.

ledgerIdstring

Return entities matching given default ledger id.

aliasstring

Return entities with aliases that contains or equals to provided alias.

providerDetails.vaultIdstring uuid

Return entities matching given vault id.

metadata.createdBystring uuid

Return entities that were created by matching user.

metadata.lastModifiedBystring uuid

Return entities that were last modified by matching user.

metadata.descriptionstring

Return entities with descriptions that contains or equals to provided description.

metadata.customPropertiesstring[]

Return entities that contains provided custom properties.

lockCoreLockStatus[]

Return entities matching given lock status(/-es).

additionalDetails.processingStatus'Pending' | 'Preparing' | 'Tracked' | 'Recovering' | 'Completed' | 'Interrupted'

Return entities matching given processing status.

additionalDetails.ledgers.ledgerIdstring[]

Return entities given ledger id.

additionalDetails.ledgers.statusCoreAccountLedgerStatus[]

Return entities having a ledger matching given status.

Response

countinteger required
currentStartingAfterstring
nextStartingAfterstring