---
title: "Get an UMA invitation by code"
method: GET
path: "/invitations/{invitationCode}"
tags: ["Invitations"]
---

# Get an UMA invitation by code

`GET /invitations/{invitationCode}`

Retrieve details about an UMA invitation by its invitation code.

## Path parameters

- `invitationCode` string, required

## Response `200`

Invitation retrieved successfully

- UmaInvitation
  - `code` string, required — The unique code of the invitation
  - `createdAt` string, date-time, required — When the invitation was created
  - `claimedAt` string, date-time — When the invitation was claimed if it has been claimed
  - `url` string, required — The URL where this invitation can be claimed.
  - `expiresAt` string, date-time — When the invitation expires (if at all)
  - `inviterUma` string, required — The UMA address of the inviter
  - `inviteeUma` string — The UMA address of the invitee
  - `status` 'PENDING' | 'CLAIMED' | 'EXPIRED' | 'CANCELLED', required — The status of the invitation
  - `firstName` string — The inviter's first name. Will be displayed when the recipient clicks the invite link
  - `amountToSend` CurrencyAmount
    - `amount` integer, required — Amount in the smallest unit of the currency (e.g., cents for USD/EUR, satoshis for BTC)
    - `currency` Currency, required
      - `code` string — Three-letter currency code (ISO 4217) for fiat currencies. Some cryptocurrencies may use their own ticker symbols (e.g. "BTC" for Bitcoin, "USDC" for USDC, etc.)
      - `name` string — Full name of the currency
      - `symbol` string — Symbol of the currency
      - `decimals` integer — Number of decimal places for the currency

## Other responses

- `401` — Unauthorized
- `404` — Invitation not found
- `500` — Internal service error

---

[API](https://skmtc.net/stainless-api/apis/grid-api.md) · [All operations](https://skmtc.net/stainless-api/apis/grid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stainless-api/grid-api/versions/151f2d9bad9c/schema)