---
updatedAt: 2026-07-29T09:34:06.000Z
---

# List transfer preapprovals

Returns transfer preapprovals, filtered by involved party and party role.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "CantonView Public API",
    "description": "Public API for accessing Canton Network explorer data through CCView",
    "contact": {
      "name": "API Maintainer",
      "email": "cantonview@pixelplex.io"
    },
    "license": {
      "name": ""
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://ccview.io",
      "description": "Production HTTPS server"
    }
  ],
  "paths": {
    "/api/preapprovals": {
      "get": {
        "tags": [
          "Transfers, Offers & Preapprovals"
        ],
        "summary": "List transfer preapprovals",
        "description": "Returns transfer preapprovals, filtered by involved party and party role.",
        "operationId": "preapprovals_list_v1",
        "parameters": [
          {
            "name": "party",
            "in": "query",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/PartyId"
            }
          },
          {
            "name": "role",
            "in": "query",
            "required": false,
            "schema": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PreapprovalPartyRole"
                }
              ],
              "default": "any"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int64",
              "default": 0
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int64",
              "default": 50
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transfer preapprovals.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PagedResponse_PreapprovalSummary"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status",
                    "message",
                    "timestamp"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Detailed message description.",
                      "example": "message error"
                    },
                    "status": {
                      "type": "integer",
                      "format": "int32",
                      "description": "HTTP status code.",
                      "maximum": 599,
                      "minimum": 400
                    },
                    "timestamp": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Timestamp of error occurrence."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status",
                    "message",
                    "timestamp"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Detailed message description.",
                      "example": "message error"
                    },
                    "status": {
                      "type": "integer",
                      "format": "int32",
                      "description": "HTTP status code.",
                      "maximum": 599,
                      "minimum": 400
                    },
                    "timestamp": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Timestamp of error occurrence."
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status",
                    "message",
                    "timestamp"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Detailed message description.",
                      "example": "message error"
                    },
                    "status": {
                      "type": "integer",
                      "format": "int32",
                      "description": "HTTP status code.",
                      "maximum": 599,
                      "minimum": 400
                    },
                    "timestamp": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Timestamp of error occurrence."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status",
                    "message",
                    "timestamp"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Detailed message description.",
                      "example": "message error"
                    },
                    "status": {
                      "type": "integer",
                      "format": "int32",
                      "description": "HTTP status code.",
                      "maximum": 599,
                      "minimum": 400
                    },
                    "timestamp": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Timestamp of error occurrence."
                    }
                  }
                }
              }
            }
          },
          "501": {
            "description": "Not Implemented",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status",
                    "message",
                    "timestamp"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Detailed message description.",
                      "example": "message error"
                    },
                    "status": {
                      "type": "integer",
                      "format": "int32",
                      "description": "HTTP status code.",
                      "maximum": 599,
                      "minimum": 400
                    },
                    "timestamp": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Timestamp of error occurrence."
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ContractId": {
        "type": "string",
        "title": "ContractId",
        "format": "byte",
        "description": "Daml contract ID encoded as a 138-character lowercase hexadecimal string",
        "example": "001dbd4eac6d06371a1dc850d3cc3d1039688403fe2f9ab98985e8e8d0701f211fca111220b859db866c3cf320cf3dda548cca9a43d7770b6a5a5937a926b771a222674385",
        "examples": [
          "001dbd4eac6d06371a1dc850d3cc3d1039688403fe2f9ab98985e8e8d0701f211fca111220b859db866c3cf320cf3dda548cca9a43d7770b6a5a5937a926b771a222674385"
        ],
        "pattern": "^00[a-f0-9]{136}$"
      },
      "EventId": {
        "type": "string",
        "title": "eventId",
        "format": "update_id:number",
        "description": "Daml event ID format: `update_id:number`.\n- `update_id`: 64-character hexadecimal string\n- `number`: **uint64**, event index within the update",
        "example": "1220f66d301e0049af910c57e04f87697d0377c6086290bf8d6f89a64fad54ad7de3:46",
        "examples": [
          "1220f66d301e0049af910c57e04f87697d0377c6086290bf8d6f89a64fad54ad7de3:46"
        ],
        "pattern": "^1220[a-f0-9]{64}:\\d+$"
      },
      "PagedResponse_PreapprovalSummary": {
        "type": "object",
        "required": [
          "data",
          "paging"
        ],
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "contract_id",
                "event_id",
                "dso_party_id",
                "receiver_party_id",
                "provider_party_id",
                "valid_from",
                "last_renewed_at",
                "expires_at",
                "record_time"
              ],
              "properties": {
                "contract_id": {
                  "$ref": "#/components/schemas/ContractId"
                },
                "dso_party_id": {
                  "$ref": "#/components/schemas/PartyId"
                },
                "event_id": {
                  "$ref": "#/components/schemas/EventId"
                },
                "expires_at": {
                  "type": "string",
                  "format": "date-time"
                },
                "last_renewed_at": {
                  "type": "string",
                  "format": "date-time"
                },
                "provider_party_id": {
                  "$ref": "#/components/schemas/PartyId"
                },
                "receiver_party_id": {
                  "$ref": "#/components/schemas/PartyId"
                },
                "record_time": {
                  "type": "string",
                  "format": "date-time"
                },
                "valid_from": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          },
          "paging": {
            "$ref": "#/components/schemas/Paging"
          }
        }
      },
      "Paging": {
        "type": "object",
        "required": [
          "limit",
          "offset",
          "total"
        ],
        "properties": {
          "limit": {
            "type": "integer",
            "format": "integer",
            "example": "10",
            "minimum": 0
          },
          "offset": {
            "type": "integer",
            "format": "integer",
            "example": "0",
            "minimum": 0
          },
          "total": {
            "type": "integer",
            "format": "integer",
            "example": "432",
            "minimum": 0
          }
        }
      },
      "PartyId": {
        "type": "string",
        "title": "PartyId",
        "format": "hint::hash",
        "description": "Party ID in format `hint::hash`\n \n- `hint` - human-readable prefix (optional, for debugging)\n \n- `hash` - cryptographic identifier (the real identity)",
        "example": "dev_test::122035334a67f4de9d2aecdd5b83485cbaee20682e3f0491bdf12b0a32d81cc93c90",
        "examples": [
          "dev_test::122035334a67f4de9d2aecdd5b83485cbaee20682e3f0491bdf12b0a32d81cc93c90"
        ],
        "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]*::1220[a-f0-9]{64}$"
      },
      "PreapprovalPartyRole": {
        "type": "string",
        "description": "Preapprovals have no `sender` role — a preapproval authorizes future inbound transfers to the\nreceiver from any sender, so only `receiver`/`provider` (plus `any`) apply.",
        "enum": [
          "any",
          "receiver",
          "provider"
        ]
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key"
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "tags": [
    {
      "name": "Transfers, Offers & Preapprovals",
      "description": "Token transfers, offers, and preapprovals"
    }
  ],
  "externalDocs": {
    "url": "https://swagger.io/resources/open-api/",
    "description": "OpenAPI Documentation Reference"
  }
}
```