Get Escrow Events

Page an escrow event timeline.

Headers

Name	Value
Content-Type	application/json
x-api-key	<token>

Open API

Page an escrow’s event timeline (keyset)

get

Addressed by the on-chain contract address (C…). Returns the full timeline a page at a time, ordered by the event’s on-chain position (ledgerSeq, txIndex, eventIndex). Page with limit + opaque cursor; order defaults to asc (chronological). Returns 404 only if the escrow is unknown on this network.

Authorizations

x-api-keystringRequired

Path parameters

contractIdstringRequired

On-chain escrow contract address (C…, 56 chars).

Example: CAAQCAIBAEAQCAIBAEAQCAIBAEAQCAIBAEAQCAIBAEAQCAIBAEAQC526

Query parameters

limitnumber · min: 1 · max: 200Optional

Page size. 1–200, defaults to 50.

Default: 50Example: 50

cursorstringOptional

Opaque cursor from the previous page’s nextCursor. Omit for page one.

orderstring · enumOptional

Timeline direction. Defaults to asc (chronological); desc for newest-first.

Default: ascPossible values:

Responses

200Success

application/json

hasMorebooleanRequired

Whether more events exist after nextCursor.

Example: true

nextCursorstring · nullableOptional

Cursor to fetch the next page, or null if this is the last.

400

Request body or query params fail schema validation (wrong type, missing required field, unknown property).

application/json

401

Missing, malformed, expired, revoked or invalid API key.

application/json

403

API key is valid but does not have the role required for this operation.

application/json

404

Escrow not found.

application/json

422

Payload is well-formed but a business rule rejects it (e.g. amount out of range, role not allowed for this user).

application/json

get/escrows/{contractId}/events

GET /escrows/{contractId}/events HTTP/1.1
Host: beta.api.trustlesswork.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "kind": "text",
      "actor": "text",
      "ledgerSeq": "text",
      "txHash": "text",
      "ledgerClosedAt": "text",
      "topics": [
        []
      ],
      "payload": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "hasMore": true,
  "nextCursor": "text"
}

GET /escrows/{contractId}/events

Pages an escrow's event timeline — every on-chain action recorded against it, in order.

Name	Type	In	Description
contractId	string	path	On-chain escrow address (C…)
limit	number	query	1–200, default 50
cursor	string	query	From the previous page's nextCursor
order	asc | desc	query	Default asc (chronological); desc for newest-first

What this Endpoint returns?

The same paginated envelope as the listing: { data, hasMore, nextCursor }.

Use it to build an activity feed, or to reconstruct what happened to an escrow and when. GET /escrows/{contractId} already includes the first 200 events, so you only need this endpoint when eventsHasMore is true or when you want newest-first.

Use Example:

import axios from "axios";

const http = axios.create({
  baseURL: "https://beta.api.trustlesswork.com",
  timeout: 10000,
  headers: {
    "Content-Type": "application/json",
    "x-api-key": your_api_key,
  },
});

export const useExample = async (contractId: string) => {
  const params = new URLSearchParams({ limit: "50", order: "desc" });

  const { data } = await http.get(
    `/escrows/${contractId}/events?${params.toString()}`,
  );

  return data;
}

These reads come from the read-model, which is eventually consistent. Right after submitting a transaction a 404 usually means "not projected yet", not "does not exist" — poll briefly instead of treating it as an error.