Get All Beneficiaries

get

https://api.zwitch.io/v1/accounts/{account_id}/beneficiaries

Use this API to get all beneficiaries for an account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

string

required

Unique identifier of the account to which the beneficiary is linked.

Example: va_Y6evcApKFXhQ9X7qKQ5AaysEI

Query Params

start_after

string

The beneficiary_id after which details should be returned.

Use this with the results_per_page for pagination.

Example: vab_EFQeD9s8dPOqsPEUZPELmpgwm

start_before

string

The beneficiary_id before which details should be returned.

Use this with the results_per_page for pagination.

Example: vab_EFQeD9s8dPOqsPEUZPELmpgwm

results_per_page

string

Defaults to 10

The number of results you want to get per API call.

Use this with the start_before or start_after parameters for pagination.

Default value 10.
Maximum value 100.

Example: 15

from_date

string

Has to be used with to_date.

The UNIX timestamp after which details should be returned.

Use this with the results_per_page, start_after, and start_before for pagination.

Example: 1651052818

to_date

string

Has to be used with from_date.

The UNIX timestamp before which details should be returned.

Use this with the results_per_page, start_after, and start_before for pagination.

Example: 1651052818

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

401401

422422