---
title: "List Payor Links"
method: GET
path: "/v1/payorLinks"
tags: ["Payors"]
---

# List Payor Links

`GET /v1/payorLinks`

This endpoint allows you to list payor links

## Query parameters

- `descendantsOfPayor` string, uuid
- `parentOfPayor` string, uuid
- `fields` string

## Response `200`

Details of Payor Links

- PayorLinksResponse — List Payor Links Response Object
  - `links` PayorLinksResponseLinks[]
    - `linkId` string, uuid, required
    - `fromPayorId` string, uuid, required
    - `linkType` 'PARENT_OF', required
    - `toPayorId` string, uuid, required
  - `payors` PayorLinksResponsePayors[]
    - `payorId` string, uuid, required
    - `payorName` string, required
    - `primaryContactEmail` string
    - `kycState` 'FAILED_KYC' | 'PASSED_KYC' | 'REQUIRES_KYC'

## Other responses

- `400` — Invalid request. See Error message payload for details of failure
- `403` — The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions
- `404` — Resource not found

## Changes

- **2020-01-28** `1b2abf26b5d6` — 4 breaking, 3 warning
  - the response's body type changed from `object` to no type for status `400`
  - the response's body type changed from `object` to no type for status `403`
  - the `errors/items/` response's property type changed from `object` to no type for status `400`
  - the `errors/items/` response's property type changed from `object` to no type for status `403`
  - …3 more
- **2019-12-11** `a0b19fa311c0` — 3 info
  - added the media type `application/json` for the response with the status `400`
  - added the media type `application/json` for the response with the status `403`
  - added the media type `application/json` for the response with the status `404`
- **2019-08-15** `696838c159e5` — 2 info
  - added the new optional `query` request parameter `parentOfPayor`
  - the `query` request parameter `descendantsOfPayor` became optional
- **2019-07-15** `ced8e167a97c` — 4 breaking, 5 warning, 3 info
  - the `query` request parameter `descendantsOfPayor` became required
  - removed the media type `application/json` for the response with the status `400`
  - removed the media type `application/json` for the response with the status `403`
  - removed the media type `application/json` for the response with the status `404`
  - …8 more

[Change history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v1/payorLinks/get.md)

---

[API](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/revisions/1b2abf26b5d6?raw)