---
title: "Get Payee Invitation Status"
method: GET
path: "/v3/payees/payors/{payorId}/invitationStatus"
tags: ["Payee Invitation"]
---

# Get Payee Invitation Status

`GET /v3/payees/payors/{payorId}/invitationStatus`

Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.

## Path parameters

- `payorId` string, uuid, required

## Query parameters

- `payeeId` string, uuid
- `invitationStatus` 'ACCEPTED' | 'PENDING' | 'DECLINED'
- `page` integer
- `pageSize` integer

## Response `200`

Get Payees with Invitaion status - filters of payeeId and invitationStatus

- PagedPayeeInvitationStatusResponse2 — List Payees Invitation Status Object
  - `page` PagedPayeeInvitationStatusResponsePage
    - `numberOfElements` integer
    - `totalElements` integer
    - `totalPages` integer
    - `page` integer
    - `pageSize` integer
  - `links` PagedPayeeResponseLinks[]
    - `rel` string
    - `href` string
  - `content` PayeeInvitationStatusResponse2[]
    - `payeeId` string, uuid, required
    - `invitationStatus` 'ACCEPTED' | 'PENDING' | 'DECLINED', required
    - `gracePeriodEndDate` string, date

## Other responses

- `400` — Invalid request. See Error message payload for details of failure
- `401` — Invalid access token. May be expired or invalid
- `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` — 1 info
  - endpoint added
- **2019-07-15** `ced8e167a97c` — 1 info
  - api path removed with deprecation

[Change history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v3/payees/payors/:payorId/invitationStatus/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)