Get Escrows By Signer

Returns all the information of an escrow requested through the signer.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Open API

get

Query parameters

signerstringOptional

Address of the user who signed the transaction to create escrow

rolestringOptional

Role in escrow

Example: approver

roleAddressstringOptional

Address of the user in the specified role

validateOnChainbooleanOptional

When set to true, the endpoint will verify each escrow’s data against the blockchain to ensure accuracy and integrity. Enabling this adds an extra security layer but may increase the response time slightly due to the additional validation step

statusstringOptional

Status of the escrow

typestringOptional

Type of the escrow

Example: single_release | multi_release

engagementIdstringOptional

Engagement ID of the escrow

Example: ENG-001

titlestringOptional

Title of the escrow

isActivebooleanOptional

Is the escrow active

startDatestringOptional

Starting date range for filtering

Example: 2023-06-20 (YYYY-MM-DD)

endDatestringOptional

Ending date range for filtering

Example: 2023-06-22 (YYYY-MM-DD)

minAmountnumberOptional

Minimum amount for filtering

maxAmountnumberOptional

Maximum amount for filtering

orderBystringOptional

Field to order the results by

Example: createdAt | updatedAt | amount

orderDirectionstringOptional

Direction to order the results

Example: asc | desc

pagenumberOptional

Page number for pagination

Example: 1

Responses

200

Collection of data containing information from different scans requested by a signatory, role or contract id.

application/json

400

Bad request

401

Unauthorized access

429

Too Many Requests

500

Possible errors:

• Both startDate and endDate must be provided together.
• Both minAmount and maxAmount must be provided together.
• The 'signer' parameter is not supported for this endpoint. -> (In case of requesting escrows per role)
• The information needed to filter by role is incomplete. -> (In case of requesting escrows per role)
• The 'role' and 'roleAddress' parameters are not supported for this endpoint. -> (In case of requesting escrows per signer)
• The 'signer' parameter is required. -> (In case of requesting escrows per signer)
• An unexpected error occurred

application/json

get

HTTPcURLJavaScriptPython

GET /helper/get-escrows-by-signer HTTP/1.1
Host: 
Accept: */*

[
  {
    "contractId": "CB25FW....",
    "signer": "GBPUA....",
    "type": "multi-release",
    "engagementId": "ENG-003",
    "title": "Title of the Escrow",
    "description": "Description of the Escrow",
    "milestones": [
      {
        "description": "Initial payment",
        "amount": 2,
        "status": "pending",
        "flags": {
          "disputed": false,
          "released": false,
          "resolved": false,
          "approved": false
        }
      },
      {
        "description": "Final payment",
        "amount": 5,
        "status": "pending",
        "flags": {
          "disputed": false,
          "released": false,
          "resolved": false,
          "approved": false
        }
      }
    ],
    "platformFee": 5,
    "receiverMemo": 0,
    "roles": {
      "approver": "GBPUACN....",
      "serviceProvider": "GA2RRI....",
      "platformAddress": "GBPA2LO....",
      "releaseSigner": "GCPZUO....",
      "disputeResolver": "GDBMRV...",
      "receiver": "GA2RRI...",
      "issuer": "GBPUAC..."
    },
    "trustline": {
      "address": "CBIELT...",
      "decimals": 10000000
    },
    "isActive": true,
    "updatedAt": {
      "_seconds": 1750698602,
      "_nanoseconds": 356000000
    },
    "createdAt": {
      "_seconds": 1750698602,
      "_nanoseconds": 356000000
    },
    "balance": 0
  }
]

Use Example:

import axios from "axios";

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

export const useExample = async () => {

    const data = await http.get(
      "/escrow/single-release/get-escrows-by-signer?signer=GPUACN...." 👈🏼 // All required parameters are passed at the query level.
    ); 
  
    return data;
}