Events

List events

get/v1/domains/{domainId}/events

Request

Base URL
https://docs.ripple.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ripple/apis/ripple-custody-api/docs/v1/domains/:domainId/events/get.ts
A function with typed inputs. Its response is checked against the schema.

domainIdstring uuid required

Unique identifier for the domain.

limitinteger

The number of entities to return.

startingAfterstring uuid

Entity id used to the determine beginning of query results.

sortBy'sequenceNumber'

Property name used to sort the query results.

sortOrder'ASC' | 'DESC'

Sort order applied to the query results.

scope'Self' | 'SelfAndDescendants'

Return events for scope of own domain, Self (default), or including subdomains, SelfAndDescendants.

countinteger required

currentStartingAfterstring

nextStartingAfterstring

No recorded changes to this operation across all 3 revisions of this API.