Pular para o conteúdo

List accounts

Requisição

Segurança
httpAuth
Caminho
domainIdstring, (uuid)obrigatório

Unique identifier for the domain.

Consulta
limitinteger, (int32), [ 1 .. 100 ]

The number of entities to return.

startingAfterstring, (uuid)

Entity id used to the determine beginning of query results.

sortBystring

Property name used to sort the query results.

Enum:"id""alias""ledgerId""lock""metadata.createdAt""metadata.lastModifiedAt"
sortOrderstring

Sort order applied to the query results.

Enum:"ASC""DESC"
ledgerIdstring, non-empty

Return entities matching given default ledger id.

Exemplo:ledgerId=1234567
aliasstring, non-empty

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

Exemplo:alias=alias1
providerDetails.vaultIdstring, (uuid)

Return entities matching given vault id.

Exemplo:providerDetails.vaultId=8e92eb53-40e7-4809-bb52-7e7b3b41a4be
metadata.createdBystring, (uuid)

Return entities that were created by matching user.

Exemplo:metadata.createdBy=fdeeeb4b-f987-4ec4-9880-1eb280581d49
metadata.lastModifiedBystring, (uuid)

Return entities that were last modified by matching user.

Exemplo:metadata.lastModifiedBy=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b
metadata.descriptionstring, >= 0 characters

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

Exemplo:metadata.description=description1
metadata.customPropertiesArray of strings

Return entities that contains provided custom properties.

Exemplo:metadata.customProperties=key1:value1&metadata.customProperties=key2:value2
lockArray of strings

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

Items Enum:"Unlocked""Locked""Archived"
Exemplo:lock=Locked&lock=Archived
additionalDetails.processingStatusstringObsoleto

Return entities matching given processing status.

Enum:"Pending""Preparing""Tracked""Recovering""Completed""Interrupted"
Exemplo:additionalDetails.processingStatus=Completed
additionalDetails.ledgers.ledgerIdArray of strings

Return entities given ledger id.

Exemplo:additionalDetails.ledgers.ledgerId=bitcoin&additionalDetails.ledgers.ledgerId=bitcoin-testnet
additionalDetails.ledgers.statusArray of strings

Return entities having a ledger matching given status.

Items Enum:"Activating""AwaitingLedgerActivation""Activated"
Exemplo:additionalDetails.ledgers.status=Activating&additionalDetails.ledgers.status=Activated
curl -i -X GET \
  'https://docs.ripple.com/_mock/pt-br/products/custody/devbox/v1/domains/{domainId}/accounts?limit=1&startingAfter=497f6eca-6276-4993-bfeb-53cbbbba6f08&sortBy=id&sortOrder=ASC&ledgerId=1234567&alias=alias1&providerDetails.vaultId=8e92eb53-40e7-4809-bb52-7e7b3b41a4be&metadata.createdBy=fdeeeb4b-f987-4ec4-9880-1eb280581d49&metadata.lastModifiedBy=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b&metadata.description=description1&metadata.customProperties=key1%3Avalue1%2Ckey2%3Avalue2&lock=Locked%2CArchived&additionalDetails.processingStatus=Completed&additionalDetails.ledgers.ledgerId=bitcoin%2Cbitcoin-testnet&additionalDetails.ledgers.status=Activating%2CActivated' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respostas

Corpoapplication/json
itemsArray of objectsobrigatório
countinteger, (int32)obrigatório
currentStartingAfterstring
nextStartingAfterstring
Resposta
{
  "items": [
    { … }
  ],
  "count": 0,
  "currentStartingAfter": "string",
  "nextStartingAfter": "string"
}