---
title: "Retrieve all payees created by an API client"
method: GET
path: "/payees"
tags: ["payees"]
---

# Retrieve all payees created by an API client

`GET /payees`

Requires **payee:read** scope. Default limit is set to 10.

## Query parameters

- `limit` integer
- `offset` integer
- `userId` string
- `hasUserId` boolean

## Response `200`

Successful Payee Response

- object
  - `data` Payee[]
    - `id` string, uuid, required — The id of the payee
    - `clientId` string, uuid, required — The id of the client
    - `sortCode` string, required — The sort code of the payee
    - `accountNumber` string, required — The account number of the payee
    - `createdAt` string, date-time, required — The date that the payee was created.
    - `modifiedAt` string, date-time, required — The date that the payee was modified.
    - `active` boolean, required — Determines if payee is active
    - `name` string, required — The name of the payee
    - `displayName` string — The name of the payee to display the end user
    - `externalId` string, nullable, required — External ID of the payee
    - `userId` string, nullable — User ID of the payee
  - `meta` Meta
    - `limit` integer
    - `offset` integer
    - `total` integer

## Other responses

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

---

[API](https://skmtc.net/moneyhubenterprise/apis/moneyhub-identity-service.md) · [All operations](https://skmtc.net/moneyhubenterprise/apis/moneyhub-identity-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moneyhubenterprise/moneyhub-identity-service/revisions/8841721f7aae/schema)