Skip to main content
GET
List Beneficiaries
Lists beneficiaries for an account with pagination and optional status / date filters. Disabled beneficiaries remain visible in listings. Returns a paginated list of beneficiary objects.
Each list item includes the same nested payment_destinations returned by Get Beneficiary; the array is empty only when the beneficiary has no available payment destinations.

Path Parameters

string
required
Id of the parent account (e.g. acct_...).

Query Parameters

int
default:"1"
Page number. Default 1, minimum 1.
int
default:"10"
Items per page. Default 10, range 1–100.
string[]
Filter by beneficiary status: active, disabled. Repeat the parameter for multiple values.
datetime
Filter by creation time, inclusive lower bound.
datetime
Filter by creation time, exclusive upper bound.

Response

Returns 200 with a paginated list of beneficiary objects.
object[]
The beneficiary objects on this page. Each item has the same shape as Get Beneficiary, including the nested payment_destinations array (available destinations only, with masked account fields).
integer
Current page number.
integer
Items per page.
integer
Total number of items.
integer
Total number of pages.