# List intents Endpoint: GET /v1/domains/{domainId}/intents Security: httpAuth ## Security: - `httpAuth` (unknown) http bearer ## Path parameters: - `domainId` (string, required) Unique identifier for the domain. ## Query parameters: - `limit` (integer) The number of entities to return. - `startingAfter` (string) Return entity intents starting after given intent. DomainId and IntentId should be separated with underscore (_) - `sortBy` (string) Property name used to sort the query results. - `sortOrder` (string) Sort order applied to the query results. - `details.payload.type` (array) Return entities intents matching given intent types. - `details.author.domainId` (string) Return entities intents matching given author domain id. - `details.author.id` (string) Return entities intents matching given author id. - `details.targetDomainId` (array) Return entities intents matching given target domain id. - `details.metadata.description` (string) Return entities intents with descriptions that contains or equals to provided description. - `details.metadata.customProperties` (array) Return entities intents that contains provided custom properties. - `state.status` (array) Return entities intents matching given status. - `entityId` (string) Return entity intents. - `revision` (integer) Return entities intents matching provided revision. - `policyId` (string) Return entities intents with matching policy id being executed. ## Response 200 fields (application/json): - `items` (array, required) - `items.data` (object, required) - `items.data.id` (string, required) - `items.data.details` (object, required) - `items.data.details.payload` (any, required) - `items.data.details.payload.reference` (object, required) - `items.data.details.payload.reference.id` (string, required) - `items.data.details.payload.reference.revision` (integer, required) - `items.data.details.payload.ledgerIds` (array) - `items.data.details.payload.type` (string, required) Enum: "v0_AddAccountLedgers", "v0_AttemptTransactionOrderCancellation", "v0_CreateAccount", "v0_CreateDomain", "v0_CreateEndpoint", "v0_CreatePolicy", "v0_CreateTicker", "v0_CreateTransactionOrder", "v0_CreateTransferOrder", "v0_CreateUser", "v0_CreateVault", "v0_ExecuteExtension", "v0_LockAccount", "v0_LockDomain", "v0_LockEndpoint", "v0_LockPolicy", "v0_LockTicker", "v0_LockUser", "v0_LockVault", "v0_MigrateSilo3AccountBatch", "v0_NotarizeData", "v0_ReleaseQuarantinedTransfers", "v0_SetSystemProperty", "v0_SignManifest", "v0_UnlockAccount", "v0_UnlockDomain", "v0_UnlockEndpoint", "v0_UnlockPolicy", "v0_UnlockTicker", "v0_UnlockUser", "v0_UnlockVault", "v0_UpdateAccount", "v0_UpdateDomain", "v0_UpdateDomainPermissions", "v0_UpdateEndpoint", "v0_UpdatePolicy", "v0_UpdateTicker", "v0_UpdateUser", "v0_UpdateVault", "v0_ValidateTickers" - `items.data.details.payload.targetTransactionOrderId` (string, required) - `items.data.details.payload.replacementTransactionOrderId` (string, required) - `items.data.details.payload.reason` (string, required) - `items.data.details.payload.maximumFee` (string) This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision. - `items.data.details.payload.id` (string, required) - `items.data.details.payload.alias` (string, required) - `items.data.details.payload.providerDetails` (any, required) - `items.data.details.payload.providerDetails.vaultId` (string, required) - `items.data.details.payload.providerDetails.keyStrategy` (string, required) Enum: "VaultHard", "VaultSoft", "Random" - `items.data.details.payload.providerDetails.type` (string, required) Enum: "Vault" - `items.data.details.payload.ledgerId` (string) - `items.data.details.payload.lock` (string, required) Enum: "Unlocked", "Locked" - `items.data.details.payload.description` (string) - `items.data.details.payload.customProperties` (object, required) - `items.data.details.payload.governingStrategy` (string) Enum: "ConsiderDescendants", "CoerceDescendants" - `items.data.details.payload.permissions` (object, required) - `items.data.details.payload.permissions.readAccess` (object, required) - `items.data.details.payload.permissions.readAccess.domains` (array, required) - `items.data.details.payload.permissions.readAccess.users` (array, required) - `items.data.details.payload.permissions.readAccess.endpoints` (array, required) - `items.data.details.payload.permissions.readAccess.policies` (array, required) - `items.data.details.payload.permissions.readAccess.accounts` (array, required) - `items.data.details.payload.permissions.readAccess.transactions` (array, required) - `items.data.details.payload.permissions.readAccess.requests` (array, required) - `items.data.details.payload.permissions.readAccess.events` (array, required) - `items.data.details.payload.users` (array, required) - `items.data.details.payload.users.id` (string, required) - `items.data.details.payload.users.alias` (string, required) - `items.data.details.payload.users.publicKey` (string, required) - `items.data.details.payload.users.roles` (array, required) - `items.data.details.payload.users.description` (string) - `items.data.details.payload.users.loginIds` (array) Domain-unique `loginId`-`loginProviderId` pairs. If not specified, a default internal login will be created. - `items.data.details.payload.users.loginIds.id` (string, required) User name. For internal login, set to the user alias. For external identity providers, must match the external provider user name. - `items.data.details.payload.users.loginIds.providerId` (string, required) Login provider. For internal login, set to `harmonize`. For external identity providers, must match the provider name. - `items.data.details.payload.policies` (array, required) - `items.data.details.payload.policies.id` (string, required) - `items.data.details.payload.policies.alias` (string, required) - `items.data.details.payload.policies.rank` (integer, required) - `items.data.details.payload.policies.intentTypes` (array) - `items.data.details.payload.policies.scope` (string, required) Enum: "Self", "Descendants", "SelfAndDescendants" - `items.data.details.payload.policies.scriptingEngine` (string, required) Enum: "Javascript_v0" - `items.data.details.payload.policies.condition` (any) Example: {"left":{"left":{"expression":"true == true","type":"Expression"},"right":{"expression":"false == true","type":"Expression"},"type":"And"},"right":{"left":{"expression":"true == false","type":"Express… - `items.data.details.payload.policies.condition.type` (string, required) Enum: "And", "Expression", "Or" - `items.data.details.payload.policies.condition.expression` (string, required) - `items.data.details.payload.policies.workflow` (array) - `items.data.details.payload.policies.description` (string) - `items.data.details.payload.address` (string, required) - `items.data.details.payload.trustScore` (integer, required) - `items.data.details.payload.parameters` (any) - `items.data.details.payload.parameters.ABI` (string) This field can be used to provide an Application Binary Interface (ABI) for EVM-based smart contracts, Ripple Custody's front-end uses the field to provide an extended support when interacting with smart contracts, therefore it is not recommended to submit invalid ABIs in this field but Ripple Custody will not prevent the submission of invalid ABIs to tolerate use cases outside of Ripple Custody's front-end. - `items.data.details.payload.parameters.type` (string, required) Enum: "Ethereum" - `items.data.details.payload.rank` (integer, required) - `items.data.details.payload.intentTypes` (array) - `items.data.details.payload.workflow` (array) - `items.data.details.payload.kind` (string, required) Enum: "Native", "Contract", "Token" - `items.data.details.payload.name` (string, required) - `items.data.details.payload.decimals` (integer) - `items.data.details.payload.symbol` (string) - `items.data.details.payload.ledgerDetails` (any, required) - `items.data.details.payload.ledgerDetails.properties` (any, required) - `items.data.details.payload.ledgerDetails.properties.type` (string, required) Enum: "Native" - `items.data.details.payload.ledgerDetails.type` (string, required) Enum: "Algorand", "Bitcoin", "Cardano", "Ethereum", "Hedera", "Solana", "Stellar", "Substrate", "Tezos", "XRPL" - `items.data.details.payload.accountId` (string, required) - `items.data.details.payload.tickerId` (string, required) - `items.data.details.payload.outputs` (array, required) - `items.data.details.payload.outputs.destination` (any, required) - `items.data.details.payload.outputs.destination.accountId` (string, required) - `items.data.details.payload.outputs.destination.type` (string, required) Enum: "Account", "Address", "Endpoint" - `items.data.details.payload.outputs.destination.address` (string, required) - `items.data.details.payload.outputs.destination.endpointId` (string, required) - `items.data.details.payload.outputs.amount` (string, required) This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision. - `items.data.details.payload.outputs.paysFee` (boolean) - `items.data.details.payload.feeStrategy` (string, required) Enum: "High", "Medium", "Low" - `items.data.details.payload.publicKey` (string, required) - `items.data.details.payload.roles` (array, required) - `items.data.details.payload.loginIds` (array) Domain-unique `loginId`-`loginProviderId` pairs. Must include at least a default internal login. External providers must be pre-configured by Ripple. - `items.data.details.payload.payload` (any, required) - `items.data.details.payload.payload.id` (string, required) - `items.data.details.payload.payload.externalAccountId` (string, required) - `items.data.details.payload.payload.parameters` (object, required) - `items.data.details.payload.payload.description` (string, required) - `items.data.details.payload.payload.customProperties` (object, required) - `items.data.details.payload.payload.type` (string, required) Enum: "Flows_v0_CreateTransactionOrder" - `items.data.details.payload.vaultId` (string, required) - `items.data.details.payload.wasColdSilo` (boolean, required) - `items.data.details.payload.wasTestSilo` (boolean, required) - `items.data.details.payload.accounts` (array, required) - `items.data.details.payload.accounts.id` (string, required) - `items.data.details.payload.accounts.alias` (string, required) - `items.data.details.payload.accounts.description` (string) - `items.data.details.payload.accounts.ledgerId` (string, required) - `items.data.details.payload.accounts.publicId` (string, required) Example: D37D-04ACF7C4 - `items.data.details.payload.data` (string, required) - `items.data.details.payload.transferIds` (array, required) - `items.data.details.payload.revision` (integer) - `items.data.details.payload.value` (any, required) - `items.data.details.payload.value.value` (object, required) - `items.data.details.payload.value.value.publicKey` (any, required) - `items.data.details.payload.value.type` (string, required) Enum: "StateReviewAuthorityProperty" - `items.data.details.payload.content` (any, required) - `items.data.details.payload.content.value` (string, required) - `items.data.details.payload.content.type` (string, required) Enum: "EIP-191", "JWT", "Unsafe" - `items.data.details.payload.content.header` (object, required) - `items.data.details.payload.content.header.type` (string) - `items.data.details.payload.content.header.algorithm` (string) - `items.data.details.payload.content.payload` (object, required) - `items.data.details.payload.content.payload.issuer` (string) - `items.data.details.payload.content.payload.subject` (string) - `items.data.details.payload.content.payload.audience` (string) - `items.data.details.payload.content.payload.expiration` (integer) - `items.data.details.payload.content.payload.notBefore` (integer) - `items.data.details.payload.content.payload.issuedAt` (integer) - `items.data.details.payload.content.payload.jwtId` (string) - `items.data.details.payload.loginIds` (array) Domain-unique `loginId`-`loginProviderId` pairs. If not specified, a default internal login will be created. - `items.data.details.payload.tickers` (array, required) - `items.data.details.payload.tickers.id` (string, required) - `items.data.details.payload.tickers.ledgerId` (string, required) - `items.data.details.payload.tickers.kind` (string, required) Enum: "Native", "Contract", "Token" - `items.data.details.payload.tickers.name` (string, required) - `items.data.details.payload.tickers.decimals` (integer) - `items.data.details.payload.tickers.symbol` (string) - `items.data.details.payload.tickers.description` (string) - `items.data.details.expiryAt` (string, required) - `items.data.details.author` (object, required) - `items.data.details.author.id` (string, required) - `items.data.details.author.domainId` (string, required) - `items.data.details.targetDomainId` (string, required) - `items.data.details.metadata` (object, required) - `items.data.details.metadata.description` (string) - `items.data.details.metadata.createdAt` (string, required) - `items.data.details.proposalSignature` (string, required) - `items.data.state` (object, required) - `items.data.state.status` (string, required) Enum: "Open", "Approved", "Executed", "Failed", "Expired", "Rejected", "Executing" - `items.data.state.lastModifiedAt` (string) - `items.data.state.error` (object) - `items.data.state.error.code` (string, required) Enum: "AccountLocked", "AccountNotReady", "DecisionInvalid", "DomainLocked", "TickerLocked", "EndpointLocked", "EntityAlreadyCreated", "EntityRevisionMismatch", "EntityAlreadyUnlocked", "EntityAlreadyLocked", "LockStatusCannotBeChanged", "IntentAlreadyComplete", "IntentAlreadyExists", "IntentMissing", "InvalidParentDomain", "LedgerNotFound", "LedgerNotProvided", "InvalidLedgerParameters", "InvalidSystemPropertyParameters", "MustBeExecutedInCurrentDomain", "MustBeExecutedInParentDomain", "MustBeExecutedInRootDomain", "NoApplicablePoliciesForDomain", "NonUniquePoliciesById", "NonUniqueUsersByAlias", "NonUniqueValidatedTickersByLedgerDetails", "NonUniqueUsersById", "NonUniqueUsersByPublicKey", "NotApplicableForRootDomain", "PolicyRevisionMismatch", "PolicyScriptingExecutionFailed", "PolicyWorkflowFailed", "PublicKeyInvalid", "LoginIdAlreadyAssigned", "ProposerIntentSignatureMismatches", "RequestExpired", "IntentExpired", "StaleIntent", "RequestSubmitterLocked", "RequestSubmitterNotFound", "RequestSubmitterSignatureInvalid", "UnsupportedAccountKeyStrategy", "VaultNotFound", "VaultLocked", "VaultNotReady", "InvalidDestination", "InvalidTransactionOrderState", "InvalidTransactionOrderParameters", "InvalidTransferOrderParameters", "InvalidEndpointUpdateParameters", "InvalidManifestContent", "BatchTooLarge", "MigrateSilo3AccountBatchContainsDuplicateDerivationData", "MigrateSilo3AccountBatchContainsDuplicateAccountIds", "MigrateSilo3AccountAlreadyImported", "InvalidTickerLedgerDetails", "DuplicateTickerIdsToValidate", "DuplicateTickerLedgerDatasToValidate", "InvalidEntityId", "MissingLoginIds", "DuplicatedLoginIds", "FeatureFlagDisabled", "InvalidCreateAccountParameters", "InvalidAddAccountLedgersParameters", "ValidateTickersPostProcessingFailure" - `items.data.state.error.message` (string, required) - `items.data.state.progressPerPolicy` (array) - `items.data.state.progressPerPolicy.stepProgress` (array, required) - `items.data.state.progressPerPolicy.stepProgress.state` (string, required) Enum: "Open", "Approved", "Failed", "Rejected" - `items.data.state.progressPerPolicy.stepProgress.decisions` (array, required) - `items.data.state.progressPerPolicy.stepProgress.decisions.authorRoles` (array, required) - `items.data.state.progressPerPolicy.stepProgress.decisions.seenBySystemAt` (string, required) - `items.data.state.progressPerPolicy.stepProgress.decisions.expiryAt` (string) - `items.data.state.progressPerPolicy.stepProgress.decisions.decision` (string, required) Enum: "Approve", "Reject" - `items.data.state.progressPerPolicy.stepProgress.decisions.approvalReason` (string) - `items.data.state.progressPerPolicy.stepProgress.decisions.rejectionReason` (string) - `items.data.state.progressPerPolicy.stepProgress.decisions.rawRequest` (string, required) - `items.data.state.progressPerPolicy.stepProgress.decisions.signature` (string, required) - `items.data.state.progressPerPolicy.policyReference` (object, required) - `items.data.state.progressPerPolicy.policyReference.id` (string, required) - `items.data.state.progressPerPolicy.policyReference.revision` (integer, required) - `items.data.state.progressPerPolicy.policyReference.domainId` (string, required) - `items.signature` (string, required) - `count` (integer, required) - `currentStartingAfter` (string) - `nextStartingAfter` (string) ## Response 400: - `400` (unknown) Invalid value for: path parameter domainId, Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameter details.payload.type, Invalid value for: query parameter details.author.domainId, Invalid value for: query parameter details.author.id, Invalid value for: query parameter details.targetDomainId, Invalid value for: query parameter details.metadata.description, Invalid value for: query parameter details.metadata.customProperties, Invalid value for: query parameter state.status, Invalid value for: query parameter entityId, Invalid value for: query parameter revision, Invalid value for: query parameter policyId ## Response 401: - `401` (unknown) One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError) ## Response 401 fields (application/json): - `reason` (string, required) - `message` (string) ## Response 404: - `404` (unknown) Entity or Domain not found (EntityNotFoundError) ## Response 404 fields (application/json): - `reason` (string, required) - `message` (string)