GET/api/v1/token-freeze-history

Get a token's freeze history

Returns every freeze and release requested on a token, filterable by target, case reference and date range, with who requested each one and whether it went on chain.

AccessRequires a permission in the workspaceMANAGE_COMPLIANCEMANAGE_WORKSPACE

Updated 08 Nov 20261 min read

Each entry is one freeze or release: who did what to which target, when, under which reason and case. call_status tells a freeze that went on chain (BROADCAST) from one that was only requested and is still collecting signatures (PENDING), so an auditor can tell the two apart.

Query parameters

contract_uidnumberRequired

The token.

workspace_idnumberRequired

The workspace the token belongs to. You must hold MANAGE_COMPLIANCE or MANAGE_WORKSPACE in it.

targetstringOptional

Only entries for this address or outpoint.

case_referencestringOptional

Only entries recorded under this case.

from_daystringOptional

Earliest day, YYYY-MM-DD.

to_daystringOptional

Latest day, YYYY-MM-DD.

bash

curl "$SQRL_API/api/v1/token-freeze-history?contract_uid=512&workspace_id=342&case_reference=CASE-2048" \
  -H "authorization: Bearer $SQRL_TOKEN"

Response200 OK

{
  "entries": [
    {
      "call_uid": 9182,
      "contract_uid": 512,
      "action": "freeze",
      "target": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
      "reason_code": 1,
      "reason_label": "Sanctions screening hit",
      "case_reference": "CASE-2048",
      "created_by": 4088,
      "created_at": "2026-11-02T09:41:07Z",
      "call_status": "BROADCAST"
    }
  ]
}

Was this page helpful?