Skip to main content
GET
/
v1
/
accounts
/
{account_id}
/
beneficiaries
List Beneficiaries
curl --request GET \
  --url https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "object": "<string>",
      "beneficiary_type": "<string>",
      "title": "<string>",
      "first_name": "<string>",
      "middle_name": "<string>",
      "last_name": "<string>",
      "display_name": "<string>",
      "company_name": "<string>",
      "status": "<string>",
      "verified": true,
      "created": "<string>"
    }
  ],
  "page": 123,
  "size": 123,
  "total": 123,
  "pages": 123
}

​
Path Parameters

​
account_id
string
required
The account’s external ID (starts with acc_)

​
Query Parameters

​
statuses
array
Filter by status (e.g., active, disabled, inactive)
​
start_date
string
Filter beneficiaries created on or after this date (ISO 8601 format)
​
end_date
string
Filter beneficiaries created before this date (ISO 8601 format)
​
page
integer
default:"1"
Page number (minimum 1)
​
size
integer
default:"10"
Items per page (1-100)

​
Response

​
items
array
Array of beneficiary objects
​
page
integer
Current page number
​
size
integer
Items per page
​
total
integer
Total number of items
​
pages
integer
Total number of pages

​
Response Example

{
  "items": [
    {
      "id": "bene_9gt1ummgx127biovlurm9mq2",
      "object": "beneficiary",
      "beneficiary_type": "individual",
      "title": "Mr",
      "first_name": "John",
      "middle_name": "Michael",
      "last_name": "Doe",
      "display_name": "John Doe",
      "company_name": null,
      "status": "active",
      "verified": true,
      "created": "2024-01-15T10:00:00Z"
    }
  ],
  "page": 1,
  "size": 10,
  "total": 1,
  "pages": 1
}