---
title: "POST /v2/events/events-by-contract-id"
method: POST
path: "/v2/events/events-by-contract-id"
---

# POST /v2/events/events-by-contract-id

`POST /v2/events/events-by-contract-id`

Get the create and the consuming exercise event for the contract with the provided ID.
No events will be returned for contracts that have been pruned because they
have already been archived before the latest pruning offset.
If the contract cannot be found for the request, or all the contract-events are filtered, a CONTRACT_EVENTS_NOT_FOUND error will be raised.

## Request body

- GetEventsByContractIdRequest
  - `contractId` string, required — The contract id being queried. Required
  - `eventFormat` EventFormat, required — A format for events which defines both which events should be included and what data should be computed and included for them. Note that some of the filtering behavior depends on the `TransactionShape`, which is expected to be specified alongside usages of `EventFormat`.
    - `filtersByParty` MapFilters
    - `filtersForAnyParty` Filters — The union of a set of template filters, interface filters, or a wildcard.
      - `cumulative` CumulativeFilter[] — Every filter in the cumulative list expands the scope of the resulting stream. Each interface, template or wildcard filter means additional events that will match the query. The impact of include_interface_view and include_created_event_blob fields in the filters will also be accumulated. A template or an interface SHOULD NOT appear twice in the accumulative field. A wildcard filter SHOULD NOT be defined more than once in the accumulative field. If no ``CumulativeFilter`` defined, the default of a single ``WildcardFilter`` with include_created_event_blob unset is used. Optional: can be empty
        - `identifierFilter` union — Required
          - object
            - `Empty` Empty1, required
          - object
            - `InterfaceFilter` InterfaceFilter, required — This filter matches contracts that implement a specific interface.
              - …
          - object
            - `TemplateFilter` TemplateFilter, required — This filter matches contracts of a specific template.
              - …
          - object
            - `WildcardFilter` WildcardFilter, required — This filter matches all templates.
              - …
    - `verbose` boolean — If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields. Optional

## Response `200`

- JsGetEventsByContractIdResponse
  - `created` JsCreated
    - `createdEvent` CreatedEvent, required — Records that a contract has been created, and choices may now be exercised on it.
      - `offset` integer, required — The offset of origin, which has contextual meaning, please see description at messages that include a CreatedEvent. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. It is a valid absolute offset (positive integer) Required
      - `nodeId` integer, required — The position of this event in the originating transaction or reassignment. The origin has contextual meaning, please see description at messages that include a CreatedEvent. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Must be valid node ID (non-negative integer) Required
      - `contractId` string, required — The ID of the created contract. Must be a valid LedgerString (as described in ``value.proto``). Required
      - `templateId` string, required — The template of the created contract. The identifier uses the package-id reference format. Required
      - `contractKey` unknown
      - `contractKeyHash` string — The hash of contract_key. This will be set if and only if ``template_id`` defines a contract key. Optional: can be empty
      - `createArgument` unknown, required
      - `createdEventBlob` string — Opaque representation of contract create event payload intended for forwarding to an API server as a contract disclosed as part of a command submission. Optional: can be empty
      - `interfaceViews` JsInterfaceView[] — Interface views specified in the transaction filter. Includes an ``InterfaceView`` for each interface for which there is a ``InterfaceFilter`` with - its party in the ``witness_parties`` of this event, - and which is implemented by the template of this event, - and which has ``include_interface_view`` set. Optional: can be empty
        - `interfaceId` string, required — The interface implemented by the matched event. The identifier uses the package-id reference format. Required
        - `viewStatus` JsStatus, required
          - `code` integer, required
          - `message` string, required
          - `details` ProtoAny[]
            - `typeUrl` string, required
            - `value` string, required
            - `unknownFields` UnknownFieldSet, required
              - …
            - `valueDecoded` string
        - `viewValue` unknown
        - `implementationPackageId` string — The package defining the interface implementation used to compute the view. Can be different from the package that was used to create the contract itself, as the contract arguments can be upgraded or downgraded using smart-contract upgrading as part of computing the interface view. Populated if the view computation is successful, otherwise empty. Optional
      - `witnessParties` string[], required — The parties that are notified of this event. When a ``CreatedEvent`` is returned as part of a transaction tree or ledger-effects transaction, this will include all the parties specified in the ``TransactionFilter`` that are witnesses of the event (the stakeholders of the contract and all informees of all the ancestors of this create action that this participant knows about). If served as part of a ACS delta transaction those will be limited to all parties specified in the ``TransactionFilter`` that are stakeholders of the contract (i.e. either signatories or observers). If the ``CreatedEvent`` is returned as part of an AssignedEvent, ActiveContract or IncompleteUnassigned (so the event is related to an assignment or unassignment): this will include all parties of the ``TransactionFilter`` that are stakeholders of the contract. The behavior of reading create events visible to parties not hosted on the participant node serving the Ledger API is undefined. Concretely, there is neither a guarantee that the participant node will serve all their create events on the ACS stream, nor is there a guarantee that matching archive events are delivered for such create events. For most clients this is not a problem, as they only read events for parties that are hosted on the participant node. If you need to read events for parties that may not be hosted at all times on the participant node, subscribe to the ``TopologyEvent``s for that party by setting a corresponding ``UpdateFormat``. Using these events, query the ACS as-of an offset where the party is hosted on the participant node, and ignore create events at offsets where the party is not hosted on the participant node. Required: must be non-empty
      - `signatories` string[], required — The signatories for this contract as specified by the template. Required: must be non-empty
      - `observers` string[] — The observers for this contract as specified explicitly by the template or implicitly as choice controllers. This field never contains parties that are signatories. Optional: can be empty
      - `createdAt` string, required — Ledger effective time of the transaction that created the contract. Required
      - `packageName` string, required — The package name of the created contract. Required
      - `representativePackageId` string, required — A package-id present in the participant package store that typechecks the contract's argument. This may differ from the package-id of the template used to create the contract. For contracts created before Canton 3.4, this field matches the contract's creation package-id. NOTE: Experimental, server internal concept, not for client consumption. Subject to change without notice. Required
      - `acsDelta` boolean, required — Whether this event would be part of respective ACS_DELTA shaped stream, and should therefore considered when tracking contract activeness on the client-side. Required
    - `synchronizerId` string, required — The synchronizer which sequenced the creation of the contract Required
  - `archived` JsArchived
    - `archivedEvent` ArchivedEvent, required — Records that a contract has been archived, and choices may no longer be exercised on it.
      - `offset` integer, required — The offset of origin. Offsets are managed by the participant nodes. Transactions can thus NOT be assumed to have the same offsets on different participant nodes. It is a valid absolute offset (positive integer) Required
      - `nodeId` integer, required — The position of this event in the originating transaction or reassignment. Node IDs are not necessarily equal across participants, as these may see different projections/parts of transactions. Must be valid node ID (non-negative integer) Required
      - `contractId` string, required — The ID of the archived contract. Must be a valid LedgerString (as described in ``value.proto``). Required
      - `templateId` string, required — Identifies the template that defines the choice that archived the contract. This template's package-id may differ from the target contract's package-id if the target contract has been upgraded or downgraded. The identifier uses the package-id reference format. Required
      - `witnessParties` string[], required — The parties that are notified of this event. For an ``ArchivedEvent``, these are the intersection of the stakeholders of the contract in question and the parties specified in the ``TransactionFilter``. The stakeholders are the union of the signatories and the observers of the contract. Each one of its elements must be a valid PartyIdString (as described in ``value.proto``). Required: must be non-empty
      - `packageName` string, required — The package name of the contract. Required
      - `implementedInterfaces` string[] — The interfaces implemented by the target template that have been matched from the interface filter query. Populated only in case interface filters with include_interface_view set. If defined, the identifier uses the package-id reference format. Optional: can be empty
    - `synchronizerId` string, required — The synchronizer which sequenced the archival of the contract Required

## Other responses

- `400` — Invalid value, Invalid value for: body
- `default`

---

[API](https://skmtc.dev/canton/apis/json-ledger-api-http-endpoints.md) · [All operations](https://skmtc.dev/canton/apis/json-ledger-api-http-endpoints/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/canton/json-ledger-api-http-endpoints/revisions/296292e8b8f1/schema)