Skip to main content
GET
/
beneficiaries
List all beneficiaries
curl --request GET \
  --url https://api.notchpay.co/beneficiaries \
  --header 'Authorization: <api-key>'
{
  "code": 200,
  "status": "OK",
  "message": "Beneficiaries retrieved",
  "items": [
    "<unknown>"
  ],
  "totals": 15,
  "last_page": 1,
  "current_page": 1,
  "selected": 15
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
limit
integer
default:30

Number of items per page

​
page
integer
default:1

Page number

​
search
string

Search by name or email

Response

Successful response

​
code
integer
required
Example:

200

​
status
string
required
Example:

"OK"

​
message
string
required
Example:

"Beneficiaries retrieved"

​
items
any[]
required
​
totals
integer
Example:

15

​
last_page
integer
Example:

1

​
current_page
integer
Example:

1

​
selected
integer
Example:

15