---
title: "Retrieve all beneficiaries for a user"
method: GET
path: "/beneficiaries"
tags: ["beneficiaries"]
---

# Retrieve all beneficiaries for a user

`GET /beneficiaries`

## Request

- Base URL: `https://api.moneyhub.co.uk/v3`
- URL: `https://api.moneyhub.co.uk/v3/beneficiaries`
- Auth: API key in header `Authorization`

Requires **beneficiaries:read** scope. Optional scope **beneficiaries_detail:read** is needed for some extra fields such as postal address.

## Query parameters

- `limit` integer
- `offset` integer
- `isUnique` boolean

## Response `200`

Successful Beneficiaries Response

- object
  - `data` Beneficiary[]
    - `id` string, required: The unique identifier for the beneficiary
    - `active` boolean, required: Shows whether the payee is currently active or not
    - `name` string: The name for the beneficiary
    - `reference` string: The reference attached to the beneficiary
    - `accountNumber` string: The beneficiary's account number
    - `sortCode` string: The beneficiary's sort code
    - `iban` string: For cash accounts. Populated with the full IBAN number.
    - `pan` string: For card accounts. Populated with the Primary Account Number.
    - `providerAccountId` string, required: The provider account ID the beneficiary belongs to
    - `providerBeneficiaryId` string, required: The provider beneficiary ID for the beneficiary
    - `accountId` string, required: The Moneyhub account ID that the beneficiary belongs to
    - `postalAddress` object: Additional postal address information for the beneficiary agent, only retrieved using **beneficiaries_detail:read** scope
    - `createdAt` string, date-time, required: The date at which the beneficiary was added.
    - `modifiedAt` string, date-time, required: The date at which the beneficiary was added.
  - `links` Links
    - `next` string, uri: The url to retrieve the next page of results from
    - `prev` string, uri: The url to retrieve the previous page of results from
    - `self` string, uri, required: The url of the current resource(s)
  - `meta` object

## Other responses

- `401`: Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
- `403`: Unsuccessful Response - Forbidden - Invalid scopes

---

[API](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-data-api-v3.md) - [All operations](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-data-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-data-api-v3/revisions/2e08b5dbee56?raw)