Anton.Docs
Dashboard (opens in a new tab)
API referenceBeneficiaries

List beneficiaries

GET/v1/beneficiaries
The request matches the contract.

Parameters

string · query
Items per page, 1 to 100. A value outside that range returns `400 invalid_limit`.
string · query
Opaque cursor returned by a previous list response. Omit for the first page.
string · query
Filter by beneficiary status.
string · query
Filter by beneficiary type.
string · query
Filter by ISO 3166-1 alpha-2 country code.
string · query
Substring match on the beneficiary's display name and external reference.
string · query
Filter by the surface that created the beneficiary.
string · query
Only beneficiaries a specific batch created. A batch ID, prefixed `bat_`.
string · query
Only beneficiaries created at or after this instant (inclusive).
string · query
Only beneficiaries created before this instant (exclusive).