Skip to main content
GET
/
beneficiaries
Get all beneficiaries
curl --request GET \
  --url https://api.example.com/beneficiaries
[
  {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "ownerName": "<string>",
    "metadata": {}
  }
]

Query Parameters

​
pageSize
integer<int64>
default:100

Number of items per page

Required range: x >= 1
​
page
integer<int64>
default:1

Page number

Required range: x >= 1
​
sort
string

Sort order

​
createdAtFrom
string<date-time>

Filter by created at date

Response

List of beneficiaries

​
id
string
required
​
createdAt
string<date-time>
required
​
ownerName
string
required
​
metadata
object