Skip to main content
POST
Retrieve beneficiaries

Headers

submitter-id
string
required

Email of API user submitting the request

Example:

"api-maker@zodia.io"

Body

application/json
statuses
string[]

Search by statuses i.e. ACTIVE or DEACTIVATED

beneficiaryIds
string[]

Search by specific beneficiary IDs

beneficiaryNames
string[]

Search by beneficiary names

entityTypes
string[]

Search by type i.e. INDIVIDUAL or ORGANISATION

companyIds
string[]

Search by company IDs

paginationLimit
number

Number of items in response (default is 10)

Example:

10

paginationOffset
number
sort
object

Response

OK

items
object[]
required
total
integer<int32>
required