# Invites

Endpoints for sending and managing user invitations

## Send invitation to a user for an entity

 - [POST /api/v1/users/invite](https://docs.wellesley.social/openapi/invites/paths/~1api~1v1~1users~1invite/post.md): Invites a local or remote user to join a local or remote entity (such as a group). For remote users or entities, include the domain in the username (e.g., user@domain.com). The invitation must be explicitly accepted or rejected by the invitee.

## Accept an invitation

 - [POST /api/v1/users/invite/accept](https://docs.wellesley.social/openapi/invites/paths/~1api~1v1~1users~1invite~1accept/post.md): Accepts a received invitation to join an entity. This confirms the invitee's willingness to join the entity (such as a group). The invitation must be in pending status to be accepted.

## List entities user was invited to

 - [GET /api/v1/users/invite/invitee/entities](https://docs.wellesley.social/openapi/invites/paths/~1api~1v1~1users~1invite~1invitee~1entities/get.md): Returns all entities (such as groups) that the authenticated user has been invited to join. Can be filtered by invitation status.

## List entities from specific inviter

 - [GET /api/v1/users/invite/invitee/entities/{inviterUser}](https://docs.wellesley.social/openapi/invites/paths/~1api~1v1~1users~1invite~1invitee~1entities~1%7Binviteruser%7D/get.md): Returns entities that a specific inviter has invited the authenticated user to join. Can be filtered by invitation status.

## List users who sent invitations

 - [GET /api/v1/users/invite/invitee/inviters](https://docs.wellesley.social/openapi/invites/paths/~1api~1v1~1users~1invite~1invitee~1inviters/get.md): Returns a list of users who have sent invitations to the authenticated user. Can be filtered by invitation status (pending, accepted, or rejected).

## List inviters for a specific entity

 - [GET /api/v1/users/invite/invitee/inviters/{entityUser}](https://docs.wellesley.social/openapi/invites/paths/~1api~1v1~1users~1invite~1invitee~1inviters~1%7Bentityuser%7D/get.md): Returns users who have invited the authenticated user to a specific entity (such as a group). Can be filtered by invitation status.

## List entities inviter has invited to

 - [GET /api/v1/users/invite/inviter/entities](https://docs.wellesley.social/openapi/invites/paths/~1api~1v1~1users~1invite~1inviter~1entities/get.md): Returns all entities that the authenticated user (as inviter) has invited other users to join. Can be filtered by invitation status.

## List users invited by the authenticated user

 - [GET /api/v1/users/invite/inviter/invitees](https://docs.wellesley.social/openapi/invites/paths/~1api~1v1~1users~1invite~1inviter~1invitees/get.md): Returns all users that the authenticated user has invited to any entity. Can be filtered by invitation status.

## List invitees for specific entity

 - [GET /api/v1/users/invite/inviter/invitees/{entityUser}](https://docs.wellesley.social/openapi/invites/paths/~1api~1v1~1users~1invite~1inviter~1invitees~1%7Bentityuser%7D/get.md): Returns users that the authenticated user has invited to a specific entity (such as a group). Can be filtered by invitation status.

## Reject an invitation

 - [POST /api/v1/users/invite/reject](https://docs.wellesley.social/openapi/invites/paths/~1api~1v1~1users~1invite~1reject/post.md): Rejects a received invitation to join an entity. This declines the invitation and updates its status to rejected. The invitation must be in pending status to be rejected.

## Revoke an invitation

 - [POST /api/v1/users/invite/undo](https://docs.wellesley.social/openapi/invites/paths/~1api~1v1~1users~1invite~1undo/post.md): Revokes a previously sent invitation to a user for an entity. This removes the pending invitation and prevents the user from accepting it. For remote users, include the domain in the username.