List effects

Retrieves all the effects from the system.

GET
/effects

Authorization

AuthorizationBearer <token>

JWT signed by private key. The presence of this token is not mandatory. It becomes required through the configuration of authorization access rules that requires a token to grant access. Once sent, the token is validated for its format, signature and expiration, regardless of the presence of access rules.

In: header

Query Parameters

page?object

Page query parameters

filter?object

Base filter parameters

Empty Object

Header Parameters

x-ledger?handle | luid

The unique identifier of ledger in context for multi tenant requests.

Response Body

fetch("http://localhost:3000/v2/effects?page.index=0&page.limit=20", {
  headers: {
    "x-ledger": "string"
  }
})

{
  "hash": "21609e02f0c56a10ae76cf9afde49fa552f4154b5634de7d1df2288d67894c63",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "digest": "e6c6930fffc28b75e7f4fcabb66717990ac91ffc61753575c1c84fd3538c48e8",
        "result": "FVFGhzaXrfavax17bt65yr2PZ3L6T9yGp31ZrTwDKB98UMTfA3QgNrVCywPCeiDLydXNMv6xunOpWlTWupCRAQ==",
        "custom": {
          "moment": "2025-04-02T05:10:33.234Z"
        }
      }
    ],
    "moment": "2025-04-02T05:10:33.234Z"
  },
  "data": [
    {
      "hash": "93f3bed329537c8db2d252ff729d291f9013c98f5cb037529d33ac61e4530918",
      "data": {
        "parent": "dc575cf8c449ca42c6df2394651f8faa84472dea96d142eb65a0aa350e4b290b",
        "handle": "signer-member-updated",
        "signal": "signer-updated",
        "filter": {
          "signer.data.schema": "member",
          "signer.meta.status": "blocked"
        },
        "action": {
          "bridge": "studio",
          "schema": "bridge"
        },
        "access": [
          {
            "action": "any",
            "signer": {
              "$record": "owner"
            }
          },
          {
            "action": "read",
            "bearer": {
              "$signer": {
                "$record": "owner"
              }
            }
          }
        ]
      },
      "luid": "$eff.-08478PVlnUAU4V4q",
      "meta": {
        "proofs": [
          {
            "custom": {
              "moment": "2025-04-02T05:10:32.080Z"
            },
            "digest": "0c450f48fc13224f848e206a4a9f44059a43b5e2a0235007dbcaf16d80e18c97",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "bsx8coKsB5N8DjEiZiNLefPFDB6rVK+eTCnn6U/o/z+r9nit7sN+RC04IlbwJsYr/HuNGyRKER5Lmz5uuN+pDA=="
          },
          {
            "custom": {
              "luid": "$eff.-08478PVlnUAU4V4q",
              "moment": "2025-04-02T05:10:32.099Z"
            },
            "digest": "1c3f0a426c9aa3d76ba9ef0a837671c4a027e1ab8f516346d8531eca04ce71ad",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "tAbjdALwaHYOW4lYjm5PSu+wx8XxCp0UDbJZ/FEyKIAaprohdtqmjZVmcnm9u/DbGiQgym0vId24Xch2uEW+Ag=="
          },
          {
            "custom": {
              "moment": "2025-04-02T05:10:30.823Z",
              "status": "active",
              "operation": "activation"
            },
            "digest": "82d18ee8d16c171ad118885d258801880c69e179151eea5151518267b7fee714",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "L4F6wmIQtoiUIPcKb3Am8F+Bh7Kv/ccdV4aDE95QubGesdAZ9+RcmFOBxXJmmQ6LGNGNmfS6+q0HWLdXG/IkBg=="
          }
        ],
        "status": "active",
        "moment": "2025-04-02T05:10:32.097Z",
        "owners": [
          "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        ]
      }
    }
  ],
  "page": {
    "index": 0,
    "limit": 10
  }
}

{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}

{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}

{
  "hash": "d48c4a6bb91c37c85625280d90a114b4983ea57089a00964e33e68d165fbecd8",
  "data": {
    "reason": "api.request-timeout",
    "detail": "Processing of request on server timed out. Your request may or may not have been processed."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "a/udgZN+Qebmkcw9GJ63MlvPiwwt6RZxzpc6+OyTTdE=",
        "digest": "295ec195e7468e1514fe9eecc0b463f9efdb45341eb06af9115c6ad9f0e2f26d",
        "result": "BJ7g1gTzJ/KeiwylEaiuzeMK7QXipBAkMaOndm3G0fjubmMCIS9wtl5wOm0X8BdYx3LLbyeh0C7zgQepsrCYBw==",
        "custom": {
          "moment": "2025-03-25T10:19:07.654Z"
        }
      }
    ]
  }
}

{
  "hash": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
  "data": {
    "reason": "record.schema-invalid",
    "detail": "Schema validator error: data.handle must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\"",
    "custom": {
      "errors": [
        {
          "instancePath": "/handle",
          "schemaPath": "#/properties/handle/pattern",
          "keyword": "pattern",
          "params": {
            "pattern": "^[a-zA-Z0-9_\\\\-+.]+$"
          },
          "message": "must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\""
        }
      ]
    }
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "vL8jKxm5PqTnJfEaRs2uOdY7gzX4CS9WbHlN3cAiBV0=",
        "digest": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
        "result": "uYxJLd2QGkEfT8rP7mCn1lHVzBvIaSK4jFqpO5ZwW9oADnMbg6yeiUsvN3tcXj0RwYxkrq5aLm9f4y2Ko8WwDw=="
      }
    ]
  }
}

{
  "hash": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
  "data": {
    "reason": "api.unexpected-error",
    "detail": "An unexpected error occurred"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "KxiLpB3v8VEdmYsT2RwNq5o1Cz9gHJfU4aAySt7D0X8=",
        "digest": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
        "result": "LzRmNh7x5TQYoqjw30BKDaZnbGcFUsX8v4tpEsr9P6iW1dyJkVC2uALfY8HdpM3eX9w0On12cqYxEtveKoFZDQ=="
      }
    ]
  }
}