Skip to main content
GET
List Outreach

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:0

Page number, 0 indexed.

Required range: x >= 0
limit
integer
default:100

Number of records per page.

Required range: 1 <= x <= 500
sort_by
string
default:created_at
Allowed value: "created_at"
sort_order
enum<string>
default:desc
Available options:
asc,
desc
payment_id
string | null

Filter by payment ID.

bank_transaction_id
string | null

Filter by bank transaction ID.

partner_id
string | null

Filter by partner ID.

outreach_type
enum<string> | null

Filter by outreach type.

Available options:
payment_receipt,
remittance_request
status
enum<string> | null

Filter by status.

Available options:
pending,
sent,
failed,
skipped

Response

Successful Response

data
OutreachLogEntry · object[]
required

The list of records.

current_page
integer
default:0
required

The current page.

total_records
integer | null
required

Total number of records.

Required range: x >= 0
next_page
integer | null
required

The next page number, if one exists.