List contracts with their raw payload

Returns one record per contract, for any Daml template on the participant, with the
contract's create arguments passed through verbatim as payload. Where the typed
endpoints (/token/*, /dtcc/*) normalise a handful of known templates into a fixed
shape, this endpoint exposes every template the caller's party scope can see — a
trading venue's CashDvp, a settlement-app Dvp/SettledDvp, an application's own workflow
contract — without this API needing to know its shape in advance.

This is state, not events. Each record is a contract as it stands: status: open
means the contract is currently active; status: closed (returned only with
includeArchived=true) means it has been archived. The record does not say which
choice archived it — for the sequence of creates and exercises, use /native/updates.
A typical integration polls this endpoint for the templates it cares about and joins
records on an application-level key carried in payload (a trade id, for example).

Always filter. Without templateId or packageName the query spans every
template on the participant, which is dominated by housekeeping records (see the note
on volume under /native/updates). packageName is the cheapest filter;
templateId is the precise one.

payload is the contract's create arguments as the ledger holds them, in Daml-LF
JSON encoding: decimals are strings, timestamps are ISO-8601 strings, parties are full
party identifiers, and optional fields are absent rather than null. Its shape is
defined by the template, not by this API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🔑

This endpoint is served under the native tier. A request is refused with 403 if the native tier is not licensed for your account.

For usage guidance, see Audit & Incremental Sync.

Query Params
string
length ≤ 512

Return only contracts of this exact fully-qualified template
(package-name:Module.Path:EntityName). Repeatable.

string
length ≤ 256

Return only contracts defined by this Daml package. Repeatable.

string
length ≤ 255
^[A-Za-z0-9_-]+::[0-9a-f]{16,}$

Return only records in which this party takes part, in any role. Matched exactly, so pass the full party identifier.

boolean
Defaults to false

When true, archived contracts are returned alongside active ones, with
status: closed. Defaults to active contracts only.

string
enum
Defaults to createdAt:desc

Ordering by creation time. createdAt:asc or createdAt:desc.

Allowed:
integer
1 to 100
Defaults to 20

Maximum number of records to return in this page.

string
length ≤ 2048

Opaque cursor from a previous response's pagination.nextPageToken. Omit for the first page.

Headers
string
length ≤ 128

Optional client-supplied correlation identifier, echoed back in the X-Request-Id response header and requestId body field.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json