Get Escrows By Signer

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

Headers

Name
Value

Content-Type

application/json

x-api-key

<token>

Open API

get
Authorizations
Query parameters
signerstringOptional

Address of the user who signed the transaction to create escrow

Example: GXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
rolestringOptional

Role in escrow

Example: approver
roleAddressstringOptional

Address of the user in the specified role

Example: GXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
statusstringOptional

Status of the escrow

Example: pending
typestring · enumOptional

Type of the escrow

Example: single_release | multi_releasePossible values:
engagementIdstringOptional

Engagement ID of the escrow

Example: ENG-001
titlestringOptional

Title of the escrow

Example: Website redesign
isActivebooleanOptional

Is the escrow active

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

startDatestringOptional

Starting date range for filtering

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

Minimum amount for filtering

Example: 100
maxAmountnumberOptional

Maximum amount for filtering

Example: 1000
orderBystring · enumOptional

Field to order the results by

Default: createdAtExample: createdAt | updatedAt | amountPossible values:
orderDirectionstring · enumOptional

Direction to order the results

Default: descExample: asc | descPossible values:
pagenumberOptional

Page number for pagination

Example: 1
contractIDstringOptional

Contract Id of the deployed escrow

Example: CBHEQBV...
endDatestringOptional

Ending date range for filtering

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

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

application/json
get
/helper/get-escrows-by-signer
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",
    "x-api-key": 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;
}
PreviousGet Multiple Escrow BalanceNextGet Escrows By Role

Last updated

Was this helpful?