GET
/
beneficiaries
curl --request GET \
  --url https://api.notchpay.co/beneficiaries \
  --header 'Authorization: <api-key>'
{
  "code": 200,
  "status": "OK",
  "message": "Beneficiaries retrieved",
  "totals": 15,
  "last_page": 1,
  "current_page": 1,
  "selected": 15,
  "items": [
    {
      "id": "ben_123456789",
      "name": "John Doe",
      "email": "john@example.com",
      "phone": 237600000000,
      "country": "CM",
      "payment_method": "pm.ndzAfIh555VCPML1",
      "created_at": "2023-01-01T12:00:00.000Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

Query Parameters

limit
integer
default:30

Number of items per page

page
integer
default:1

Page number

Search by name or email

Response

200
application/json

Successful response

The response is of type object.