HEAD
/
api
/
ledger
/
{ledger}
/
transactions
curl --request HEAD \
  --url http://localhost:55001/api/ledger/{ledger}/transactions \
  --header 'Authorization: Bearer <token>'
This response does not have an example.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

ledger
string
required

Name of the ledger.

Example:

"ledger001"

Query Parameters

reference
string

Filter transactions by reference field.

Example:

"ref:001"

account
string

Filter transactions with postings involving given account, either as source or destination (regular expression placed between ^ and $).

Example:

"users:001"

source
string

Filter transactions with postings involving given account at source (regular expression placed between ^ and $).

Example:

"users:001"

destination
string

Filter transactions with postings involving given account at destination (regular expression placed between ^ and $).

Example:

"users:001"

startTime
string

Filter transactions that occurred after this timestamp. The format is RFC3339 and is inclusive (for example, "2023-01-02T15:04:01Z" includes the first second of 4th minute).

start_time
string
deprecated

Filter transactions that occurred after this timestamp. The format is RFC3339 and is inclusive (for example, "2023-01-02T15:04:01Z" includes the first second of 4th minute). Deprecated, please use startTime instead.

endTime
string

Filter transactions that occurred before this timestamp. The format is RFC3339 and is exclusive (for example, "2023-01-02T15:04:01Z" excludes the first second of 4th minute).

end_time
string
deprecated

Filter transactions that occurred before this timestamp. The format is RFC3339 and is exclusive (for example, "2023-01-02T15:04:01Z" excludes the first second of 4th minute). Deprecated, please use endTime instead.

metadata
object

Filter transactions by metadata key value pairs. Nested objects can be used as seen in the example below.

Response

200

OK