List beneficiaries

List registered beneficiaries with query filtering options.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

This is the last_evaluated_creation_datetime field from the response. You can use it to get the next page of results on a subsequent call.

string

Number of items per page, min=1, max=100, default=20.

string
enum

Sort order. Results are ordered on the created_datetime field. Default=DESC.

Allowed:
string
length ≤ 50

Beneficiary name

string
length ≤ 20

Beneficiary alias

boolean

Return only active or non-active beneficiaries flag. If not passed, all beneficiares are returned.

Headers
string
required

Account token - Token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized error.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json