API Reference

List dashboard updates

get
https://example.com/api/v2/parties//dashboard/updates

Returns classified updates the caller can read, with filters for asset, classification, party, text, and date, plus sorting and page controls.

Path Params
string
required

Canton party identifier.

Query Params
string

Sort field: datetime or amount. Defaults to datetime.

string

Sort direction: asc or desc. Defaults to desc.

int32

Maximum transactions to return. Defaults to 20 and is limited to 1,000.

string

Cursor returned with the previous page.

types
array of strings

Classification types to include; repeat the parameter for multiple values.

types
excludeTypes
array of strings

Classification types to exclude; cannot be combined with types.

excludeTypes
parties
array of strings

Counterparty addresses to include; repeat the parameter for multiple values.

parties
boolean

Restrict results to transactions where the requested party is an actor. Defaults to false.

string

Text to match in the transaction.

string

Use 'canton_coin' to select Canton Coin. This cannot be combined with an instrument pair.

string

Private instrument administrator; must be supplied with instrumentId.

string

Private instrument identifier; must be supplied with instrumentAdmin.

date-time

Start of the requested period, included in results.

date-time

End of the requested period, excluded from results.

string

Ledger API JWT alternative to the jwt header.

string

Configured validator-node identifier; defaults to the deployment default.

Headers
string

Ledger API JWT used to resolve the caller's party permissions.

string

Configured validator-node identifier alternative to the nodeId query parameter.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 2 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 2 days ago

Did this page help you?