---
title: "Get a buddy list invitation context object by share code"
method: GET
path: "/v1/buddy-list/invitations/{shareCode}"
tags: ["buddy-list"]
---

# Get a buddy list invitation context object by share code

`GET /v1/buddy-list/invitations/{shareCode}`

## Path parameters

- `shareCode` string, required

## Response `200`

The found buddy list invitation context object

- BuddyListInvitationEntity
  - `invitingPlayerIsRegistered` 'true' | 'false', required
  - `invitingPlayerGameResults` GameSetResult[], required
    - `gameId` string, required
    - `correctAnswer` boolean
  - `entityType` object, required
  - `invitingPlayerId` string, required
  - `invitingPlayerUsername` string, required
  - `invitingPlayerAnalyticsId` string, required
  - `shareCode` string, required
  - `distributorId` string, required
  - `deepLinkUrl` string, required
  - `gameSetId` string, required
  - `gameSetAttempt` number
  - `invitationDate` number, required
  - `buddyListId` string, required

## Other responses

- `404` — No invitation found for the given share code

---

[API](https://skmtc.net/versusgame/apis/versusgame-api.md) · [All operations](https://skmtc.net/versusgame/apis/versusgame-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/versusgame/versusgame-api/revisions/e86f45ae5f7c/schema)