---
title: "Get the caller's invitation link and who joined with it"
method: GET
path: "/api/me/invite-link"
---

# Get the caller's invitation link and who joined with it

`GET /api/me/invite-link`

## Request

- Base URL: `https://www.toma.com`
- URL: `https://www.toma.com/api/me/invite-link`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `better-auth.session_token`

Created the first time it is asked for. While Toma is invite-only, anyone who signs in and opens it becomes a member; it consumes the same invitation allowance as email invites (default five; INVITE_LIMIT=0 means unlimited). Same as the get_my_invite_link MCP tool.

## Response `200`

The member's link.

- MyInviteLink
  - `id` string, required
  - `link` string, uri, required: Open this link to accept the invitation after signing in.
  - `uses` integer, required: How many accounts were let in with it.
  - `pendingEmailInvitations` integer, required: Unredeemed email reservations consuming the shared allowance.
  - `pendingInvitations` object[], required: This member's unredeemed email invitations, newest first; provider acceptance is not inbox delivery.
    - `id` string, required
    - `email` string, email, required
    - `state` 'sending' | 'sent', required
    - `createdAt` string, date-time, required
  - `revoked` boolean, required: Staff turned it off; it no longer lets anyone in.
  - `invitees` Invitee[], required
    - `id` string, required
    - `name` string, required
    - `headline` string, nullable, required
    - `photoUrl` string, nullable, required
    - `joinedAt` string, date-time, required
    - `pending` boolean, required: Still on the sign-up steps, so their member page isn't public yet.
  - `allowance` InviteAllowance, required
    - `limit` integer, nullable, required: Total invitation limit across email and shared links; null means unlimited.
    - `used` integer, required: Members admitted with the link plus unredeemed email reservations; each person counts once.
    - `remaining` integer, nullable, required: Remaining invitation places; null means unlimited.

## Other responses

- `401`: No valid session or API key.
- `403`: Still signing up, or email unverified.

---

[API](https://skmtc.dev/toma/apis/toma-api.md) - [All operations](https://skmtc.dev/toma/apis/toma-api/llms.txt) - [OpenAPI document](https://skmtc.dev/toma/apis/toma-api/revisions/b4e56e1db5a2?raw)