---
title: "List Payout Holds"
method: GET
path: "/payout_holds"
tags: ["Payout Holds"]
---

# List Payout Holds

`GET /payout_holds`

## Request

- Base URL: `https://api.justifi.ai/v1`
- URL: `https://api.justifi.ai/v1/payout_holds`
- Auth: none declared. Required headers: `Authorization`
- TypeScript: <https://skmtc.dev/justifi/apis/justifi-api-documentation/docs/payout_holds/get.ts> (a function with typed inputs; its response is checked against the schema)

List the payout holds that belong to this account. This endpoint supports [pagination](https://docs.justifi.tech/api-spec#section/Pagination).

## Query parameters

- `created_before` string, date-time
- `created_after` string, date-time
- `start_date_before` string, date
- `start_date_after` string, date
- `end_date_before` string, date
- `end_date_after` string, date

## Headers

- `Authorization` string, required

## Response `200`

Successfully list payout holds

- object
  - `id` number: the object id
  - `type` string: the object type, or array of objects
  - `data` PayoutHold[]: the list of objects
    - `id` string
    - `account_id` string
    - `hold_type` 'first_payment' | 'manual'
    - `issued_by` 'system' | 'platform'
    - `start_date` string, date
    - `end_date` string, date, nullable
    - `active` boolean
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `page_info` PageInfo
    - `end_cursor` string: the encoded id of the last record in the current list
    - `has_next` boolean: true if the collection contains records following the current list
    - `has_previous` boolean: true if the collection contains records ahead of the current list
    - `start_cursor` string: the encoded id of the first record in the current list

---

[API](https://skmtc.dev/justifi/apis/justifi-api-documentation.md) - [All operations](https://skmtc.dev/justifi/apis/justifi-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/justifi/apis/justifi-api-documentation/revisions/dd9f3fed7e46?raw)