Sign in
inbox-agents

List every inbox agent that is recorded in the Masumi registry inbox. (READ access required)

Gets the inbox agent metadata.

get/inbox-agents

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/inbox-agents
  • Auth: API key in header token

Query parameters

limitnumber

The number of inbox registry entries to return

cursorIdstring

The cursor id to paginate through the results

network'Preprod' | 'Mainnet' required

The Cardano network used to register the inbox agent on

filterSmartContractAddressstring nullable

The smart contract address of the payment source. When omitted, inbox registry list/count endpoints default to Web3CardanoV1 for backwards compatibility. Supplying this field queries that exact V1 or V2 source.

filterStatus'Registered' | 'Deregistered' | 'Pending' | 'Failed'

Filter by inbox registration status category

searchQuerystring

Search query to filter by name, description, agent slug, minting or recipient wallet address, or state

Response

Inbox agent metadata

status'success' required

Example response

{
  "status": "success",
  "data": {
    "Assets": [
      {
        "error": null,
        "id": "inbox_registry_id",
        "name": "Inbox Agent",
        "description": "Masumi inbox identity registration",
        "agentSlug": "inbox-agent",
        "state": "RegistrationRequested",
        "createdAt": "1970-01-20T20:00:36.260Z",
        "updatedAt": "1970-01-20T20:00:36.260Z",
        "lastCheckedAt": null,
        "agentIdentifier": "policy_id_asset_name_policy_id_asset_name_policy_id_asset_name",
        "metadataVersion": 1,
        "sendFundingLovelace": null,
        "SmartContractWallet": {
          "walletVkey": "wallet_vkey",
          "walletAddress": "wallet_address"
        },
        "RecipientWallet": null,
        "CurrentTransaction": null
      }
    ]
  }
}

Changes

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