Skip to main content
GET
List Beneficiaries
Lists the account’s beneficiaries, newest first by creation time. Disabled beneficiaries are included; deleted ones are not. Each item is the full beneficiary object, including its non-deleted payout destinations. Requires an API key with read access on the payments scope.

Path Parameters

string
required
The account’s external ID (starts with acct_)

Query Parameters

array
Filter by status. Repeat the key to pass several values, for example ?statuses=active&statuses=disabled. Allowed values are active and disabled, lowercase; anything else returns 422.
boolean
Whether to return only the account holder’s own beneficiaries. false returns only third-party ones, and omitting it returns both.
string
Only beneficiaries created on or after this ISO 8601 timestamp (inclusive)
string
Only beneficiaries created before this ISO 8601 timestamp (exclusive)
integer
default:"1"
Page number (minimum 1)
integer
default:"10"
Items per page (1-100)

Response

array
Beneficiary objects, newest first
integer
Current page number
integer
Items per page
integer
Total number of items
integer
Total number of pages

Request Example

Response Example