listEscrows

List escrows with keyset pagination and filters (GET /escrows).

List escrows with keyset pagination and filters (GET /escrows).

Import

import { TrustlessWorkClient } from "@trustless-work/escrow-js";

Signature

client.rest.listEscrows(params?: ListEscrowsParams): Promise<ListEscrowsResponse>

Returns ListEscrowsResponse = KeysetPage<EscrowSummary> → { data, hasMore, nextCursor }.

Filters: scope, status, type, engagementId, contractIds, participant, role, platformId, subjectId, createdAfter, createdBefore, limit, cursor, sort, order.

type is "single-release" or "multi-release". Rows include amount (decimal string, or null until the first projection).

Example

import { TrustlessWorkClient, development } from "@trustless-work/escrow-js";

const client = new TrustlessWorkClient({
  baseURL: development,
  apiKey: process.env.API_KEY,
});

// see signature above

See REST Reads.