---
title: "Get the group invite link"
method: POST
path: "/invitations/groups/{groupId}/link"
tags: ["invitations"]
---

# Get the group invite link

`POST /invitations/groups/{groupId}/link`

## Request

- Base URL: `http://localhost:3001`
- URL: `http://localhost:3001/invitations/groups/{groupId}/link`
- Auth: HTTP bearer

Returns the group's reusable invite link, creating it on first use. Any active member may call it; the same link comes back until an admin regenerates it, and its expiry rolls forward as members keep sharing it.

## Path parameters

- `groupId` string, required

## Response `200`

Group invite link retrieved successfully

- object
  - `data` GroupInviteLinkResponseDto
    - `token` string, required: Shareable token
    - `url` string, required: Full URL
    - `expiresAt` string, required: ISO8601 expiration timestamp
    - `maxUses` number: Maximum uses (if any)
    - `currentUses` number, required: Current uses
    - `groupName` string, required: Group name
    - `isGroupLink` boolean, required: Always true: the group's reusable link
  - `success` boolean
  - `message` string

## Other responses

- `400`: Bad Request - Invalid input or validation failed
- `401`: Unauthorized - Authentication required or invalid token
- `403`: Forbidden - Insufficient permissions to access this resource
- `404`: Not Found - The requested resource does not exist
- `500`: Internal Server Error - An unexpected error occurred

---

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