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

# Get Payee Invitation Status

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

## Request

- Base URL: `https://api.sandbox.velopayments.com`
- URL: `https://api.sandbox.velopayments.com/v4/payees/payors/{payorId}/invitationStatus`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.sandbox.velopayments.com/v1/login`

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` string
- `page` integer
- `pageSize` integer

## Response `200`

Get Payees with Invitaion status - filters of payeeId and invitationStatus

- PagedPayeeInvitationStatusResponseV4: List Payees Invitation Status Object
  - `page` PagedPayeeInvitationStatusResponseV3Page
    - `numberOfElements` integer
    - `totalElements` integer
    - `totalPages` integer
    - `page` integer
    - `pageSize` integer
  - `links` PagedPayeeResponseV3Links[]
    - `rel` string
    - `href` string
  - `content` PayeeInvitationStatusResponseV4[]
    - `payeeId` string, uuid, required
    - `invitationStatus` string, required: Payee invitation status. One of the following values: ACCEPTED, PENDING, DECLINED
    - `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`: The resource was not found or is no longer available

## Changes

- **2022-08-10** `1e7a1734a45c`: 3 breaking, 3 info
  - removed the enum value `ACCEPTED` from the `query` request parameter `invitationStatus`
  - removed the enum value `DECLINED` from the `query` request parameter `invitationStatus`
  - removed the enum value `PENDING` from the `query` request parameter `invitationStatus`
  - removed the `ACCEPTED` enum value from the `content/items/invitationStatus` response property for the response status `200`
  - …2 more
- **2020-10-30** `dd71433847a6`: 4 breaking, 24 info
  - the `errors/items/` response's property type changed from no type to `object` for status `400`
  - the `errors/items/` response's property type changed from no type to `object` for status `401`
  - the `errors/items/` response's property type changed from no type to `object` for status `403`
  - the `errors/items/` response's property type changed from no type to `object` for status `404`
  - …24 more
- **2020-08-13** `75bb7af5ae63`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v4/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/05c3f09fc50a?raw)