Skip to content

/v1/domains/{domainId}/external-accounts

Request

List external accounts

Security
httpAuth
Path
domainIdstring, (uuid)required
Query
limitinteger, (int32)
startingAfterstring, (uuid)
sortOrderstring
Enum:"ASC""DESC"
sortBystring
Enum:"id""alias""createdAt""lastModifiedAt"
connectionIdstring, (uuid)
aliasstring
ledgerIdstring
externalTickerNamestring
connectionStatestring
Enum:"Connected""Disconnected""ConnectionError""InvalidConnection"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/custody/devbox/v1/domains/{domainId}/external-accounts?limit=0&startingAfter=497f6eca-6276-4993-bfeb-53cbbbba6f08&sortOrder=ASC&sortBy=id&connectionId=497f6eca-6276-4993-bfeb-53cbbbba6f08&alias=string&ledgerId=string&externalTickerName=string&connectionState=Connected' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
itemsArray of objectsrequired
countinteger, (int32)required
currentStartingAfterstring or null, (uuid)
nextStartingAfterstring or null, (uuid)
Response
{ "items": [ { … } ], "count": 0, "currentStartingAfter": "651be221-e717-4828-840c-fe29ed82c461", "nextStartingAfter": "2e35122f-8704-4d6f-b465-9a3a43a644e9" }