# List intents

Endpoint: GET /v1/domains/{domainId}/intents
Security: httpAuth

## 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.
    Enum: "id", "state.status", "details.expiryAt", "details.metadata.createdAt", "state.lastModifiedAt"

  - `sortOrder` (string)
    Sort order applied to the query results.
    Enum: "ASC", "DESC"

  - `details.payload.type` (array)
    Return entities intents matching given intent types.
    Enum: "v0_NotarizeData", "v0_ExecuteExtension", "v0_CreateDomain", "v0_UpdateDomain", "v0_UpdateDomainPermissions", "v0_UnlockDomain", "v0_LockDomain", "v0_CreateUser", "v0_UpdateUser", "v0_UnlockUser", "v0_LockUser", "v0_CreatePolicy", "v0_UpdatePolicy", "v0_UnlockPolicy", "v0_LockPolicy", "v0_CreateVault", "v0_UpdateVault", "v0_UnlockVault", "v0_LockVault", "v0_UnlockTicker", "v0_LockTicker", "v0_CreateEndpoint", "v0_UpdateEndpoint", "v0_UnlockEndpoint", "v0_LockEndpoint", "v0_CreateAccount", "v0_MigrateSilo3AccountBatch", "v0_UpdateAccount", "v0_UnlockAccount", "v0_LockAccount", "v0_AddAccountLedgers", "v0_CreateTransactionOrder", "v0_ReleaseQuarantinedTransfers", "v0_CreateTicker", "v0_AttemptTransactionOrderCancellation", "v0_ValidateTickers", "v0_UpdateTicker", "v0_CreateTransferOrder", "v0_SignManifest", "v0_SetSystemProperty", "v0_CreateLedger", "v0_UpdateLedger", "v0_AddTrustedPublicKeysForMigration"

  - `details.author.domainId` (string)
    Return entities intents matching given author domain id.
    Example: "8e92eb53-40e7-4809-bb52-7e7b3b41a4be"

  - `details.author.id` (string)
    Return entities intents matching given author id.
    Example: "fdeeeb4b-f987-4ec4-9880-1eb280581d49"

  - `details.targetDomainId` (array)
    Return entities intents matching given target domain id.
    Example: ["fdeeeb4b-f987-4ec4-9880-1eb280581d49"]

  - `details.metadata.description` (string)
    Return entities intents with descriptions that contains or equals to provided description.
    Example: "description1"

  - `details.metadata.customProperties` (array)
    Return entities intents that contains provided custom properties.
    Example: ["key1:value1","key2:value2"]

  - `state.status` (array)
    Return entities intents matching given status.
    Enum: "Open", "Approved", "Executed", "Failed", "Expired", "Rejected", "Executing"

  - `entityId` (string)
    Return entity intents.
    Example: "90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b"

  - `revision` (integer)
    Return entities intents matching provided revision.
    Example: "100"

  - `policyId` (string)
    Return entities intents with matching policy id being executed.
    Example: "8e92eb53-40e7-4809-bb52-7e7b3b41a4be"

## 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.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.metadata.customProperties` (object, 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", "InvalidEndpointCreateParameters", "InvalidManifestContent", "BatchTooLarge", "MigrateSilo3AccountBatchContainsDuplicateDerivationData", "MigrateSilo3AccountBatchContainsDuplicateAccountIds", "MigrateSilo3AccountAlreadyImported", "InvalidTickerLedgerDetails", "DuplicateTickerIdsToValidate", "DuplicateTickerLedgerDatasToValidate", "InvalidEntityId", "MissingLoginIds", "DuplicatedLoginIds", "FeatureFlagDisabled", "InvalidCreateAccountParameters", "InvalidAddAccountLedgersParameters", "CurrentPublicKeyNotMatching", "InvalidTrustedCollectionPublicKeySignature", "InvalidMigrationKeyMaterial", "InvalidEntityType", "DuplicatePublicKey", "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.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)

  - `items.signingKey` (string, required)

  - `count` (integer, required)

  - `currentStartingAfter` (string)

  - `nextStartingAfter` (string)

## Response 401 fields (application/json):

  - `reason` (string, required)

  - `message` (string)