List circle changes
GET/circles/{id}/changes●Retrieve the change history of a circle by its handle or LUID.
Each change contains a complete snapshot of the record at that
point in time, the action performed (create, update, or
drop), and a timestamp. Changes are returned newest first.
After a record is deleted, its change history remains accessible but must be queried using the record's LUID instead of its handle.
Usage Examples
curl -X GET "http://localhost:3000/v2/circles/<HANDLE>/changes" \ -H "x-ledger: <YOUR LEDGER HANDLE>"{
"hash": "91cb67f2fdb3d593f40cfe9231a9e355ef802e40c03891492947213b4999c368",
"data": [
{
"luid": "$crc.-01xK3tUvW4fU6yZ5",
"hash": "f5f460dface7a8ecb37db8d9241b0fe447ee76a120dcdeb7944351ca2f0cf71b",
"data": {
"handle": "admin",
"parent": "855bc7d94e12eb5ed2f58af16dd6dbcedeeb2d3f80340d9fbc8976fd1c31dc7c",
"custom": {
"description": "Administrative access circle"
}
},
"meta": {
"status": "created",
"action": "update",
"change": 2,
"moment": "2025-04-05T14:30:00.220Z",
"owners": [
"AN6XpZ7T8FDCkjbSpIVE2cioQ7hajp8DBTOioz/TSZ8="
],
"proofs": [
{
"signer": "ach-admin",
"method": "ed25519-v2",
"digest": "e21c4a25dbdd88dd258036bcba71c42fa60d6476a727119e28287c749b9fc317",
"public": "AN6XpZ7T8FDCkjbSpIVE2cioQ7hajp8DBTOioz/TSZ8=",
"result": "Y2Q45F1SsrE3JoaCb3c5zb9EMBOfwemADV3MhNCK3hvpRVRioMO6EOjN/TUMLlBjHF/vcX/Gp2KGtiAQTPx2DQ==",
"custom": {
"moment": "2025-04-05T14:30:00.200Z"
}
},
{
"signer": "system",
"method": "ed25519-v2",
"digest": "34fadda874704fefafb8c1fac76aaea5a381ccbb42ccb342da4595c36f8cb0d3",
"public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
"result": "6IAMd+phi7kJYJLqHmxXeuD55TiMjuoZITNK5Drld0S4myaK7lxZH14cEfAFrWFqBONl4f5QoL5w3tQksJq3DQ==",
"custom": {
"luid": "$crc.-01xK3tUvW4fU6yZ5",
"moment": "2025-04-05T14:30:00.220Z"
}
}
]
}
},
{
"luid": "$crc.-01xK3tUvW4fU6yZ5",
"hash": "855bc7d94e12eb5ed2f58af16dd6dbcedeeb2d3f80340d9fbc8976fd1c31dc7c",
"data": {
"handle": "admin"
},
"meta": {
"status": "created",
"action": "create",
"change": 1,
"moment": "2025-04-05T14:30:00.050Z",
"owners": [
"AN6XpZ7T8FDCkjbSpIVE2cioQ7hajp8DBTOioz/TSZ8="
],
"proofs": [
{
"signer": "ach-admin",
"method": "ed25519-v2",
"digest": "4ad98da772474baaba41b5425773586cd23f1e8d7514b7b7776012842c446953",
"public": "AN6XpZ7T8FDCkjbSpIVE2cioQ7hajp8DBTOioz/TSZ8=",
"result": "YZyvyq8MGm3X35i7J31JlPVbGwekquXAw+nL6M0JiU3H7Dxcg/de2rd3cCSwYywxq5+5rBvCl38g+gdrJs9nAA==",
"custom": {
"moment": "2025-04-05T14:30:00.000Z",
"status": "created"
}
},
{
"signer": "system",
"method": "ed25519-v2",
"digest": "2bee4f906deb32ffd75b7e1d88f0d45fafdf6d658cfd1d68bcb890e020b3915c",
"public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
"result": "28PT93eVJSWAlNPZtX7yMz/ykDCxQ0YDtgVwV6WfsIBk0nQvRFqsqXurxbLCJfTj2IcbE0b5MdAcfS8stOZ+Ag==",
"custom": {
"luid": "$crc.-01xK3tUvW4fU6yZ5",
"moment": "2025-04-05T14:30:00.050Z",
"status": "created"
}
}
]
}
}
],
"page": {
"index": 0,
"limit": 20,
"total": 2
},
"meta": {
"moment": "2025-04-05T14:30:00.300Z",
"proofs": [
{
"signer": "system",
"method": "ed25519-v2",
"digest": "aa3d169029be4ffa45769d46befc1c4cf1a16a5eb8e0b8da1c5d356b8ed41e80",
"public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
"result": "PMAijBY3/pI+VwFshUX7YWdrBQv/oFeUpF0FR4WCrddI4QveVQKLr4Mz72MLRtqIkofQ9fynR8ic3OkkEFZGAw==",
"custom": {
"moment": "2025-04-05T14:30:00.100Z"
}
}
]
}
}{
"hash": "b7eb7ccf5ffc126951e13e29a8dcfdaf95db859715d4edfc2d16f59a79d4cd58",
"data": {
"reason": "auth.unauthorized",
"detail": "Invalid token."
},
"meta": {
"proofs": [
{
"signer": "system",
"method": "ed25519-v2",
"digest": "3acece870c4118bfe4223118e4d2f3cfd5b8947a7093785b66d49aa57fa2890a",
"public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
"result": "gnK63DqqWDY/UXvnZHixDKPKS6tfeGHgdARylnPiJLwQGyYxuD97TYbSg2wrzsf/bDrHwQYZaf8Gu5ryYP0UAA==",
"custom": {
"moment": "2025-04-05T14:30:00.000Z"
}
}
]
}
}{
"hash": "9ec02726b50650add8acfd124c6defeb978a9ac252a5de888f9493ddc701e927",
"data": {
"reason": "auth.forbidden",
"detail": "Request is not authorized"
},
"meta": {
"proofs": [
{
"signer": "system",
"method": "ed25519-v2",
"digest": "4f8cbdc38d73348de0c31805c783c84a0fecc6be736d7e187004ba68cd00e675",
"public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
"result": "P3hRnveehtuobb4AIO56XBmiduvmYJbpdmOHltG/IifBEH7QSWdv/0pqled4SO9x1Ne3oXuWxJy40DzMvx1MBA==",
"custom": {
"moment": "2025-04-05T14:30:00.000Z"
}
}
]
}
}{
"hash": "d6c59a6df7165fa4a75159799ca5f5e26e544cbb8769eced3d35d8021f6f7935",
"data": {
"reason": "record.not-found",
"detail": "Signer not found"
},
"meta": {
"proofs": [
{
"signer": "system",
"method": "ed25519-v2",
"digest": "78cf86f34aefcf9da6ed4167a38aac0a2739f68f7bafb1d3e033c01ed1b6cdf1",
"public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
"result": "9Ledk+/iAAtj+uLjGe2afq4kID7n8UQD6UpRpLBCujxFjxddq0uZ2tnYRTAXmYdHDkbF0uXqtNM9qO3xhEtpAA==",
"custom": {
"moment": "2025-04-05T14:30:00.000Z"
}
}
]
}
}{
"hash": "1c084e8dcfb9bb84bc8ea96e9e137b149a34b2bbd85f8e60b4263f5aba980476",
"data": {
"custom": {
"errors": [
{
"instancePath": "/handle",
"schemaPath": "#/properties/handle/pattern",
"keyword": "pattern",
"params": {
"pattern": "^[a-zA-Z0-9_\\-+.]+$"
},
"message": "must match pattern \"^[a-zA-Z0-9_\\-+.]+$\""
}
]
},
"reason": "record.schema-invalid",
"detail": "Schema validator error: data.handle must match pattern \"^[a-zA-Z0-9_\\-+.]+$\""
},
"meta": {
"proofs": [
{
"signer": "system",
"method": "ed25519-v2",
"digest": "7a5febb431719b6f43d7e88e79211308e16ac651b71b339276373fdb4e7c3760",
"public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
"result": "2/1zYw4AaIzsIHfOIC6V/CHw6owbjYHt48cwmFOig0ibeT0IbojLmj1RCRi8W00ka0udPa9WsacWDd7ObMY8CA==",
"custom": {
"moment": "2025-04-05T14:30:00.000Z"
}
}
]
}
}{
"hash": "93a5f4d97a42c2df97f827c58ff7768d02568c15aca931e22b81fa3160ba0df3",
"data": {
"reason": "api.unexpected-error",
"detail": "An unexpected error occurred"
},
"meta": {
"proofs": [
{
"signer": "system",
"method": "ed25519-v2",
"digest": "efaf5360143b586917d9636779ad6e08571c5b06909a20dd0f5eba4bf3be7eae",
"public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
"result": "hERh6Aecj59iR+Fb25OQsHJScOi4t8EiffKSfjlMQdjHMccTnfDlgZFdaJzXzUtpSwy/NHq0l+7ydh3HSWCoAg==",
"custom": {
"moment": "2025-04-05T14:30:00.000Z"
}
}
]
}
}Path Parameters
id*|
The unique identifier of the record - it is luid or handle (address).
Query Parameters
page?
Pagination options. Set limit and index to page through results.
filter?
Filter by field values using dot notation (e.g. data.handle=value). Operators like $in and $regex are optional — equality is the default.
Header Parameters
x-ledger?|
The unique identifier of ledger in context for multi tenant requests.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
Check circle access POST
Evaluates access policies for the calling signer and returns the resolved permissions. The request body specifies the action and optionally the record type to check against.
Get circle change GET
Returns a single change by its sequence number. The change includes a full record snapshot as it existed at that point.