---
title: "List Outreach"
method: GET
path: "/v2/cash-app/outreach"
tags: ["cash-app"]
---

# List Outreach

`GET /v2/cash-app/outreach`

## Request

- Base URL: `https://api.stuut.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.stuut.ai/v2/cash-app/outreach`
- Auth: HTTP bearer

List Cash App Outreach Log

List outreach log entries for the organization.
Can be filtered by payment_id, bank_transaction_id, partner_id, outreach_type, and status.

## Query parameters

- `page` integer: Page number, 0 indexed.
- `limit` integer: Number of records per page.
- `sort_by` 'created_at'
- `sort_order` 'asc' | 'desc'
- `payment_id` string, nullable: Filter by payment ID.
- `bank_transaction_id` string, nullable: Filter by bank transaction ID.
- `partner_id` string, nullable: Filter by partner ID.
- `outreach_type` 'payment_receipt' | 'remittance_request'
- `status` 'pending' | 'suggested' | 'sent' | 'failed' | 'skipped'

## Response `200`

Successful Response

- PaginatedResponseOutreachLogEntry
  - `data` OutreachLogEntry[], required: The list of records.
    - `created_at` string, date-time, required
    - `modified_at` string, date-time, nullable, required
    - `id` string, required
    - `outreach_type` 'payment_receipt' | 'remittance_request', required
    - `status` 'pending' | 'suggested' | 'sent' | 'failed' | 'skipped', required
    - `skip_reason` string, nullable, required: The reason the outreach was skipped, if applicable.
    - `bank_transaction_id` string, nullable, required: The bank transaction this outreach is associated with (used for remittance requests).
    - `payment_id` string, nullable, required: The payment this outreach is associated with.
    - `partner_id` string, required: The partner this outreach is sent to.
    - `email_id` string, nullable, required: The email record created for this outreach, if sent.
    - `object` string, required: String representing the object's type. Objects of the same type share the same value.
  - `current_page` integer, required: The current page.
  - `total_records` integer, nullable, required: Total number of records.
  - `next_page` integer, nullable, required: The next page number, if one exists.

## Other responses

- `422`: Validation Error

---

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