---
title: "GET /pledges"
method: GET
path: "/pledges"
tags: ["Pledges"]
---

# GET /pledges

`GET /pledges`

Search Pledge

## Query parameters

- `account_id` integer, nullable
- `asset_manager_id` integer, nullable
- `exchange_id` integer, nullable
- `page` integer, nullable
- `page_size` integer, nullable
- `state` string[], nullable

## Response `200`

pledge search results

- APISearchPledgeResults
  - `edges` PledgeSearchResult[], required
    - `cursor` integer, required
    - `node` Pledge, required
      - `account_id` integer, required
      - `amount` integer, required
      - `asset_manager` TradelinkAssetManager, required
        - `code` string, required
        - `id` string, required
        - `name` string, required
        - `role` string, required
      - `custodian` TradelinkCustodian, required
        - `code` string, required
        - `id` string, required
        - `name` string, required
        - `role` string, required
      - `exchange` TradelinkExchange, required
        - `code` string, required
        - `id` string, required
        - `name` string, required
        - `role` string, required
      - `id` string, uuid, required
      - `pending` integer, required
      - `pledge_subaccount_id` integer, required
      - `state` 'ASSIGNED_TO_SETTLEMENT' | 'OUTBOUND_TRANSACTION_CONFIRMED' | 'OUTBOUND_TRANSACTION_FAILED' | 'PLEDGE_APPROVED' | 'PLEDGE_CONSUMED' | 'PLEDGE_INCREMENT_PENDING_APPROVAL' | 'PLEDGE_READY' | 'PLEDGE_REJECTED' | 'RECOVERING_FROM_FAILURE' | 'REPLEDGE_APPROVED' | 'REPLEDGE_PENDING_APPROVAL' | 'REPLEDGE_REJECTED' | 'UNPLEDGE_APPROVED' | 'UNPLEDGE_PENDING_APPROVAL' | 'UNPLEDGE_REJECTED', required
  - `page_info` APISearchPageInfo, required
    - `count` integer, required
    - `has_next_page` boolean, required

## Other responses

- `400` — invalid search parameters

---

[API](https://skmtc.net/ledgerhq/apis/vault-api.md) · [All operations](https://skmtc.net/ledgerhq/apis/vault-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ledgerhq/vault-api/revisions/c88faa17bc25/schema)