---
title: "List Wallet Invites"
method: GET
path: "/wallet/invites"
tags: ["Invites"]
---

# List Wallet Invites

`GET /wallet/invites`

This API method allows the calling application to retrieve all invites using either the GUID or reference (or both).

## Query parameters

- `guid` string, string
- `reference` string, string
- `walletId` string, string
- `state[]` string, string
- `status[]` string, string
- `type[]` string, string
- `unitId[]` string, string
- `dateCreated` string
- `lastUpdated` string
- `validFrom` string
- `validTo` string
- `limit` integer
- `offset` integer

## Response `200`

OK

- WalletInvitesEntity
  - `limit` integer — Results per page
  - `total` integer — Total Results
  - `offset` integer — Offset
  - `orderBy` object[] — Order by criteria.
    - `name` string — The sorting key
    - `order` string — The sorting direction.
  - `results` WalletInviteEntity[]
    - `walletInviteId` string — Invite ID
    - `walletId` string — The Wallet ID
    - `guid` string — Invite GUID
    - `description` string — Invite description
    - `reference` string — Invite reference
    - `status` 'ACTIVE' | 'CANCELLED' | 'EXPIRED' | 'ACCEPTED' | 'REJECTED' — Invite status
    - `state` string — Invite state
    - `type` string — Type of the Invite
    - `meta` MetaEntity
      - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value
      - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value
    - `validFrom` string — Date this invite is valid from
    - `validTo` string — Date this invite is valid to
    - `dateCreated` string — Date this invite was created
    - `lastUpdated` string — Date this invite was last updated

## Other responses

- `400` — Bad Request.
- `401` — Unauthorized.
- `403` — Forbidden.
- `404` — Not Found.
- `415` — Unsupported Media Type
- `423` — Locked
- `429` — Too Many Requests
- `500` — Server Error

---

[API](https://skmtc.net/eagleeye/apis/wallet-api.md) · [All operations](https://skmtc.net/eagleeye/apis/wallet-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeye/wallet-api/versions/90a122bb14cc/schema)