---
title: "List intents"
method: GET
path: "/v1/domains/{domainId}/intents"
tags: ["Intents"]
---

# List intents

`GET /v1/domains/{domainId}/intents`

## Path parameters

- `domainId` string, uuid, required

## Query parameters

- `limit` integer
- `startingAfter` string
- `sortBy` 'id' | 'state.status' | 'details.expiryAt' | 'details.metadata.createdAt' | 'state.lastModifiedAt'
- `sortOrder` 'ASC' | 'DESC'
- `details.payload.type` CoreIntentType[]
- `details.author.domainId` string, uuid
- `details.author.id` string, uuid
- `details.author.subject` string
- `details.targetDomainId` string[]
- `details.metadata.description` string
- `details.metadata.customProperties` string[]
- `state.status` CoreIntentStatus[]
- `entityId` string
- `revision` integer
- `policyId` string, uuid

## Response `200`

- CoreTrustedIntentsCollection
  - `items` CoreTrustedIntent[], required
    - `data` CoreIntentEntity, required
      - `id` string, uuid, required
      - `details` CoreIntentDetails, required
        - `payload` union, required
          - CoreV0AcknowledgeBackup
            - `backupId` string, uuid, required
            - `type` 'v0_AcknowledgeBackup', required
          - CoreV0AddAccountLedgers
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `ledgerIds` string[]
            - `type` 'v0_AddAccountLedgers', required
          - CoreV0AddTrustedPublicKeysForMigration
            - `newCollectionSigningPublicKey` string, base64, required
            - `newMessageSigningPublicKey` string, base64, required
            - `newApiSigningPublicKey` string, base64, required
            - `newKeyMaterial` string, required
            - `currentCollectionSigningPublicKey` string, base64, required
            - `currentCollectionSigningPublicKeySignature` string, base64, required
            - `type` 'v0_AddTrustedPublicKeysForMigration', required
          - CoreV0AttemptTransactionOrderCancellation
            - `targetTransactionOrderId` string, uuid, required
            - `replacementTransactionOrderId` string, uuid, required
            - `reason` string, required
            - `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.
            - `type` 'v0_AttemptTransactionOrderCancellation', required
          - CoreV0CreateAccount
            - `id` string, uuid, required
            - `alias` string, required
            - `providerDetails` CoreV0CreateAccountProviderDetailsPayload, required
              - …
            - `ledgerId` string
            - `ledgerIds` string[]
            - `lock` 'Unlocked' | 'Locked', required
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `type` 'v0_CreateAccount', required
          - CoreV0CreateBackup
            - `id` string, uuid, required
            - `parameters` union, required
              - …
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `type` 'v0_CreateBackup', required
          - CoreV0CreateDomain
            - `id` string, uuid, required
            - `alias` string, required
            - `lock` 'Unlocked' | 'Locked', required
            - `governingStrategy` 'ConsiderDescendants' | 'CoerceDescendants'
            - `permissions` CorePermissions, required
              - …
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `users` CoreCreateDomainGenesisUser[], required
              - …
            - `policies` CoreCreateDomainGenesisPolicy[], required
              - …
            - `childrenDomainIds` string[] — List of `domainId` values to reparent under the new domain. Populate this field only for domain injection.
            - `type` 'v0_CreateDomain', required
          - CoreV0CreateEndpoint
            - `id` string, uuid, required
            - `address` string, required
            - `trustScore` integer, required
            - `ledgerId` string, required
            - `parameters` CoreEndpointLedgerParameters
              - …
            - `alias` string, required
            - `lock` 'Unlocked' | 'Locked', required
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `type` 'v0_CreateEndpoint', required
          - CoreV0CreateLedger
            - `id` string, required
            - `alias` string, required
            - `parameters` union, required
              - …
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `type` 'v0_CreateLedger', required
          - CoreV0CreatePolicy
            - `id` string, uuid, required
            - `alias` string, required
            - `rank` integer, required
            - `intentTypes` CoreIntentType[]
            - `scope` 'Self' | 'Descendants' | 'SelfAndDescendants', required
            - `scriptingEngine` 'Javascript_v0', required
            - `condition` union
              - …
            - `workflow` CoreWorkflowCondition[]
              - …
            - `lock` 'Unlocked' | 'Locked', required
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `intentOrigin` 'UserSigned' | 'SystemSigned'
            - `type` 'v0_CreatePolicy', required
          - CoreV0CreateTicker
            - `ledgerId` string, required
            - `kind` 'Native' | 'Contract' | 'Token', required
            - `name` string, required
            - `decimals` integer
            - `symbol` string
            - `ledgerDetails` union, required
              - …
            - `type` 'v0_CreateTicker', required
          - CoreV0CreateTransactionOrder
            - `id` string, uuid, required
            - `accountId` string, uuid, required
            - `ledgerId` string
            - `parameters` union, required
              - …
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `type` 'v0_CreateTransactionOrder', required
          - CoreV0CreateTransferOrder
            - `id` string, uuid, required
            - `accountId` string, uuid, required
            - `tickerId` string, uuid, required
            - `outputs` CoreCreateTransferOrderOutput[], required
              - …
            - `feeStrategy` 'High' | 'Medium' | 'Low', required
            - `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.
            - `preferredAddressForChange` 'PrimaryAddress' — Hint for specifically bitcoin ledgers to have the transaction happen with addressForChange PrimaryAddress - so change utxo goes to address \0\0 - aligned with dry-runs - rather than the default generate a new chain-internal address.
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `type` 'v0_CreateTransferOrder', required
          - CoreV0CreateUser
            - `id` string, uuid, required
            - `alias` string, required
            - `publicKey` string, base64, required
            - `roles` string[], required
            - `lock` 'Unlocked' | 'Locked', required
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `loginIds` CoreLoginId[] — Domain-unique `loginId`-`loginProviderId` pairs. Must be specified for login and match pre-configured values.
              - …
            - `type` 'v0_CreateUser', required
          - CoreV0CreateVault
            - `id` string, uuid, required
            - `alias` string, required
            - `parameters` union
              - …
            - `publicKey` string, base64, required
            - `lock` 'Unlocked' | 'Locked', required
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `type` 'v0_CreateVault', required
          - CoreV0ExecuteExtension
            - `payload` object, required
            - `type` 'v0_ExecuteExtension', required
          - CoreV0LockAccount
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `type` 'v0_LockAccount', required
          - CoreV0LockDomain
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `type` 'v0_LockDomain', required
          - CoreV0LockEndpoint
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `type` 'v0_LockEndpoint', required
          - CoreV0LockPolicy
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `type` 'v0_LockPolicy', required
          - CoreV0LockTicker
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `type` 'v0_LockTicker', required
          - CoreV0LockUser
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `type` 'v0_LockUser', required
          - CoreV0LockVault
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `type` 'v0_LockVault', required
          - CoreV0MigrateSilo3AccountBatch
            - `vaultId` string, uuid, required
            - `wasColdSilo` boolean, required
            - `wasTestSilo` boolean, required
            - `accounts` CoreV3AccountToMigrate[], required
              - …
            - `type` 'v0_MigrateSilo3AccountBatch', required
          - CoreV0NotarizeData
            - `data` string, required
            - `type` 'v0_NotarizeData', required
          - CoreV0RegisterTrustedPublicKey
            - `publicKey` string, base64, required
            - `purpose` 'ApiSignatures' | 'TrustedCollectionSignatures' | 'MessagingSignatures' | 'SystemSignatures', required
            - `type` 'v0_RegisterTrustedPublicKey', required
          - CoreV0ReleaseQuarantinedTransfers
            - `accountId` string, uuid, required
            - `transferIds` string[], required
            - `type` 'v0_ReleaseQuarantinedTransfers', required
          - CoreV0RewrapVaultKeyMaterial
            - `vaultId` string, uuid, required
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `type` 'v0_RewrapVaultKeyMaterial', required
          - CoreV0SetSystemProperty
            - `revision` integer
            - `value` union, required
              - …
            - `type` 'v0_SetSystemProperty', required
          - CoreV0SignManifest
            - `id` string, uuid, required
            - `accountId` string, uuid, required
            - `ledgerId` string
            - `content` union, required
              - …
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `type` 'v0_SignManifest', required
          - CoreV0UnlockAccount
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `type` 'v0_UnlockAccount', required
          - CoreV0UnlockDomain
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `type` 'v0_UnlockDomain', required
          - CoreV0UnlockEndpoint
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `type` 'v0_UnlockEndpoint', required
          - CoreV0UnlockPolicy
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `type` 'v0_UnlockPolicy', required
          - CoreV0UnlockTicker
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `type` 'v0_UnlockTicker', required
          - CoreV0UnlockUser
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `type` 'v0_UnlockUser', required
          - CoreV0UnlockVault
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `type` 'v0_UnlockVault', required
          - CoreV0UpdateAccount
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `alias` string, required
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `type` 'v0_UpdateAccount', required
          - CoreV0UpdateDomain
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `alias` string, required
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `type` 'v0_UpdateDomain', required
          - CoreV0UpdateDomainPermissions
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `permissions` CorePermissions, required
              - …
            - `type` 'v0_UpdateDomainPermissions', required
          - CoreV0UpdateEndpoint
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `address` string, required
            - `trustScore` integer, required
            - `ledgerId` string
            - `parameters` CoreEndpointLedgerParameters
              - …
            - `alias` string, required
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `type` 'v0_UpdateEndpoint', required
          - CoreV0UpdateLedger
            - `reference` CoreEntityStringIdAndRevision, required
              - …
            - `alias` string, required
            - `parameters` union, required
              - …
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `type` 'v0_UpdateLedger', required
          - CoreV0UpdatePolicy
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `alias` string, required
            - `rank` integer, required
            - `intentTypes` CoreIntentType[]
            - `scope` 'Self' | 'Descendants' | 'SelfAndDescendants', required
            - `scriptingEngine` 'Javascript_v0', required
            - `condition` union
              - …
            - `workflow` CoreWorkflowCondition[]
              - …
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `intentOrigin` 'UserSigned' | 'SystemSigned'
            - `type` 'v0_UpdatePolicy', required
          - CoreV0UpdateTicker
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `name` string, required
            - `decimals` integer
            - `symbol` string
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `type` 'v0_UpdateTicker', required
          - CoreV0UpdateUser
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `alias` string, required
            - `roles` string[], required
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `loginIds` CoreLoginId[] — Domain-unique `loginId`-`loginProviderId` pairs. Must be specified for login and match pre-configured values.
              - …
            - `type` 'v0_UpdateUser', required
          - CoreV0UpdateVault
            - `reference` CoreEntityIdAndRevision, required
              - …
            - `alias` string, required
            - `parameters` union
              - …
            - `description` string
            - `customProperties` CoreStringsMap, required
            - `type` 'v0_UpdateVault', required
          - CoreV0ValidateTickers
            - `tickers` CoreTickerToValidate[], required
              - …
            - `type` 'v0_ValidateTickers', required
        - `expiryAt` string, date-time, required
        - `author` union, required
          - CoreIntentAuthorService
            - `subject` string, required
          - CoreIntentAuthorUser
            - `id` string, uuid, required
            - `domainId` string, uuid, required
        - `targetDomainId` string, uuid, required
        - `metadata` CoreIntentMetadata, required
          - `description` string
          - `createdAt` string, date-time, required
          - `customProperties` CoreStringsMap, required
        - `proposalSignature` string, base64, required
        - `signingKey` string, base64
      - `state` CoreIntentState, required
        - `status` 'Open' | 'Approved' | 'Executed' | 'Failed' | 'Expired' | 'Rejected' | 'Executing', required
        - `lastModifiedAt` string, date-time
        - `error` CoreIntentError
          - `code` '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' | 'SystemSignatureInvalid' | 'SystemSigningKeyNotRegistered' | 'SystemSigningKeyMismatch' | 'SystemSignaturesKeyAlreadyRegistered' | 'SystemSignedProcessingDisabled' | 'UnsupportedAccountKeyStrategy' | 'VaultNotFound' | 'VaultLocked' | 'VaultHasRandomKeyAccounts' | 'VaultNotReady' | 'InvalidDestination' | 'InvalidTransactionOrderState' | 'InvalidTransactionOrderParameters' | 'InvalidTransferOrderParameters' | 'InvalidEndpointUpdateParameters' | 'InvalidEndpointCreateParameters' | 'InvalidManifestContent' | 'BatchTooLarge' | 'MigrateSilo3AccountBatchContainsDuplicateDerivationData' | 'MigrateSilo3AccountBatchContainsDuplicateAccountIds' | 'MigrateSilo3AccountAlreadyImported' | 'InvalidTickerLedgerDetails' | 'DuplicateTickerIdsToValidate' | 'DuplicateTickerLedgerDatasToValidate' | 'InvalidEntityId' | 'MissingLoginIds' | 'DuplicatedLoginIds' | 'FeatureFlagDisabled' | 'InvalidCreateAccountParameters' | 'InvalidAddAccountLedgersParameters' | 'CurrentPublicKeyNotMatching' | 'InvalidTrustedCollectionPublicKeySignature' | 'InvalidMigrationKeyMaterial' | 'InvalidEntityType' | 'DuplicatePublicKey' | 'UnsupportedTrustedPublicKeyPurpose' | 'TrustedPublicKeyAlreadyActive' | 'InvalidVaultParameters' | 'BackupNotReady' | 'BackupAcknowledgeDenied' | 'VaultOperationOnExternalAccount' | 'ExternalOperationOnVaultAccount' | 'ValidateTickersPostProcessingFailure', required
          - `message` string, required
        - `progressPerPolicy` CoreWorkflowProgress[]
          - `stepProgress` CoreWorkflowStep[], required
            - `state` 'Open' | 'Approved' | 'Failed' | 'Rejected', required
            - `decisions` CoreDecisionPayload[], required
              - …
          - `policyReference` CorePolicyReference, required
            - `id` string, uuid, required
            - `revision` integer, required
            - `domainId` string, uuid, required
    - `signature` string, base64, required
    - `signingKey` string, base64, required
  - `count` integer, required
  - `currentStartingAfter` string
  - `nextStartingAfter` string

## Other responses

- `400` — 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.author.subject, 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
- `401` — One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)
- `404` — Entity or Domain not found (EntityNotFoundError)

---

[API](https://skmtc.net/ripple/apis/ripple-custody-api.md) · [All operations](https://skmtc.net/ripple/apis/ripple-custody-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ripple/ripple-custody-api/revisions/0b55c0ddf07a/schema)
