# Beneficiary list

Retrieves a summarised list of all beneficiaries in the Fund including their status, display name, and member number.

Endpoint: GET /f/{businessCode}/{fundCode}/beneficiary-data/list-beneficiaries
Version: 1.0
Security: Class_oAuth

## Path parameters:

  - `businessCode` (string, required)
    Class business code

  - `fundCode` (string, required)
    Class entity code

## Response 200 fields (application/json):

  - `Data` (array, required)

  - `Data.BeneficiarySummaries` (array, required)
    Collection of beneficiary summary records

  - `Data.BeneficiarySummaries.Link` (object, required)

  - `Data.BeneficiarySummaries.Link.Id` (string, required)

  - `Data.BeneficiarySummaries.Link.Url` (string, required)

  - `Data.BeneficiarySummaries.Status` (string, required)
    The status of a beneficiary or account within the Fund
    Enum: "Active", "Cancelled", "Pending", "Suspended"

  - `Data.BeneficiarySummaries.DefaulDisplayName` (string, required)
    The default display name for the beneficiary
    Example: John Smith

  - `Data.BeneficiarySummaries.BeneficiaryNumber` (string, required)
    The unique member number assigned to the beneficiary within the Fund
    Example: 1

  - `Errors` (array)

  - `Errors.code` (string)

  - `Errors.message` (string)

## Response 400 fields (application/json):

  - `Errors` (array)

  - `Errors.code` (string)

  - `Errors.message` (string)

## Response 401 fields (application/json):

  - `Errors` (array)

  - `Errors.Code` (string)
    Example: API_NOT_AUTHORISED

  - `Errors.Message` (string)
    Example: Not authorised

## Response 403 fields (application/json):

  - `Errors` (array)

  - `Errors.Code` (string)
    Example: FORBIDDEN

  - `Errors.Message` (string)
    Example: You do not have permission to access this resource.

## Response 404 fields (application/json):

  - `Errors` (array)

  - `Errors.Code` (string)
    Example: API_NOT_FOUND

  - `Errors.Message` (string)
    Example: Resource not available or user does not have access to the fund.

## Response 500 fields (application/json):

  - `Errors` (array)

  - `Errors.Code` (string)
    Example: API_INTERNAL_ERROR

  - `Errors.Message` (string)
    Example: An unexpected error occurred on the server. Please try again later.

## Response default fields (application/json):

  - `Errors` (array)

  - `Errors.Code` (string)
    Example: API_INTERNAL_ERROR

  - `Errors.Message` (string)
    Example: An unexpected error occurred on the server. Please try again later.