v1

latestOpenAPI 3.1.02026-07-2631037.6 KB

List all beneficiaries

get/beneficiaries

Query parameters

limitinteger

Number of items per page

pageinteger

Page number

searchstring

Search by name or email

Response

Successful response

codeinteger required
statusstring required
messagestring required
totalsinteger
last_pageinteger
current_pageinteger
selectedinteger

Example response

{
  "code": 200,
  "status": "OK",
  "message": "Beneficiaries retrieved",
  "totals": 15,
  "last_page": 1,
  "current_page": 1,
  "selected": 15
}