Skip to main content
GET
/
beneficiaries
Get beneficiaries
curl --request GET \
  --url https://processor-prod.up.railway.app/beneficiaries \
  --header 'x-service-key: <api-key>'
{
  "success": true,
  "status": 200,
  "message": "Beneficiaries fetched successfully",
  "timestamp": "2025-09-08T21:16:13.410Z",
  "data": {
    "beneficiaries": [
      {
        "id": "68bf2eba196a18d7bd166184",
        "is_active": true,
        "currency": "ngn",
        "details": {}
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 10
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.bread.africa/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-service-key
string
header
required

Query Parameters

​
page
integer
default:1

This is the current page being requested relative to size of a page

Response

200 - application/json

Beneficiaries fetched successfully

​
success
boolean
Example:

true

​
status
integer
Example:

200

​
message
string
Example:

"Beneficiaries fetched successfully"

​
timestamp
string<date-time>
Example:

"2025-09-08T21:16:13.410Z"

​
data
object