Skip to content
Docs/
API reference
/
/
List Beneficiaries

List Beneficiaries

Request

Returns a paginated list of beneficiaries. Optionally filter by status.

Security
JWT
Query
statusstring

Filter beneficiaries by status.

Enum:"pending""active""rejected"
Example:status=active
pageinteger

Page number for pagination.

Example:page=1
per_pageinteger

Number of results per page.

Example:per_page=20
curl -i -X GET \
  'https://api.glomopay.com/api/v2/beneficiaries?status=active&page=1&per_page=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

A paginated list of beneficiaries

Bodyapplication/json
dataArray of objects(BeneficiaryV2)
page_metaobject
Response
{
  "data": [
    { … }
  ],
  "page_meta": {
    "current": 1,
    "previous": null,
    "next": null,
    "per_page": 20,
    "pages": 1,
    "count": 10
  }
}