Skip to main content
GET
Retrieve all Mass Beneficiaries submissions
Obtain the full list of mass beneficiaries async process status for a given client_id. The status field will provide the latest status whether processing is complete or still running.

Authorizations

x-api-key
string
header
required

An API Key.

Headers

Authorization
string
required

The access token

Query Parameters

client_id
string
required

The ID of the client

page
integer<int32>

The desired page number for pagination. By default is 1.

page-size
integer<int32>

The number of items per page for pagination. By default is 50.

Response

List of mass beneficiary submissions

mass_beneficiary_id
string<uuid>

Unique UUID of the mass beneficiary

error
object

An error message.

Links for the mass beneficiary related information. Each link helps the user agent to fetch resources related to errored beneficiaries, and also those created successfully. The mass_beneficiary_id does not need to be stored as the said resources may be accessed with the provided links.

summary
object

Categorized counters for the mass beneficiary.

status
enum<string>

This is an enumeration of the status of every mass beneficiary instruction

Available options:
pending,
creating,
created,
failed,
unknown