# alfaview API v2

> HTTP API of the alfaview video conferencing platform for managing rooms, meetings, users, the company, permissions, guests, files and reports.

The base URL of this API version is `https://apis.alfaview.com/v2`. Every page linked below is plain markdown; the operation pages are rendered from the OpenAPI specification and contain parameters, request and response schemas and JSON examples.

## Documentation

- [alfaview API v2 overview](https://apis.alfaview.com/v2/docs/overview.md): Quickstart, formats, pagination, errors, authentication and permissions
- [Changelog](https://apis.alfaview.com/v2/docs/changelog.md): History of API changes by production release date

## Authentication

- [Authenticate via API Key](https://apis.alfaview.com/v2/docs/operations/AuthenticateAPIKey.md): Authenticates via an API key and returns an access token.
- [Authenticate via Password](https://apis.alfaview.com/v2/docs/operations/AuthenticatePassword.md): Authenticates a user via username and password and returns an access token.
- [Authenticate a Guest (Guest Link)](https://apis.alfaview.com/v2/docs/operations/AuthenticateGuestLink.md): Tries to authenticate a guest link guest via access key.
- [Authenticate a Guest (Group Link)](https://apis.alfaview.com/v2/docs/operations/AuthenticateGroupLink.md): Tries to authenticate a group link guest via access key.
- [Get Access Token Information](https://apis.alfaview.com/v2/docs/operations/GetTokenInfo.md): Retrieves details about the access token provided in the Authorization header.

## Rooms

- [List Rooms](https://apis.alfaview.com/v2/docs/operations/ListRooms.md): Lists rooms.
- [Get Room](https://apis.alfaview.com/v2/docs/operations/GetRoom.md): Gets a single room.
- [Create Room](https://apis.alfaview.com/v2/docs/operations/CreateRoom.md): Creates a room.
- [Update Room](https://apis.alfaview.com/v2/docs/operations/UpdateRoom.md): Updates a room.
- [Delete Room](https://apis.alfaview.com/v2/docs/operations/DeleteRoom.md): Deletes a room.
- [List Subrooms](https://apis.alfaview.com/v2/docs/operations/ListSubrooms.md): Lists subrooms.
- [Create Subroom](https://apis.alfaview.com/v2/docs/operations/CreateSubroom.md): Creates a subroom.
- [Update Subroom](https://apis.alfaview.com/v2/docs/operations/UpdateSubroom.md): Updates a subroom.
- [Delete Subroom](https://apis.alfaview.com/v2/docs/operations/DeleteSubroom.md): Deletes a subroom.
- [Get Room Features](https://apis.alfaview.com/v2/docs/operations/GetRoomFeatures.md): Gets the room features of a room.
- [Update Room Features](https://apis.alfaview.com/v2/docs/operations/UpdateRoomFeatures.md): Updates the room features of a room.
- [Delete Room Features](https://apis.alfaview.com/v2/docs/operations/DeleteRoomFeatures.md): Sets all the room features of a room to default.
- [List Room Types](https://apis.alfaview.com/v2/docs/operations/ListRoomTypes.md): Lists room types.
- [List Room Permissions](https://apis.alfaview.com/v2/docs/operations/ListPermissions.md): Lists permissions applied in a room.
- [Create Room Permissions](https://apis.alfaview.com/v2/docs/operations/CreatePermissions.md): Creates permissions for a user that are applied in a room.
- [Update Room Permissions](https://apis.alfaview.com/v2/docs/operations/UpdatePermissions.md): Updates permissions of a user that are applied in a room.
- [Delete Room Permissions](https://apis.alfaview.com/v2/docs/operations/DeletePermissions.md): Deletes permissions of a user that are applied in a room.
- [List Participants](https://apis.alfaview.com/v2/docs/operations/ListParticipants.md): Lists data about the participants who are currently in a room.
- [Get Language Settings](https://apis.alfaview.com/v2/docs/operations/GetLanguageSettings.md): Gets the language settings of a room.
- [Update Language Settings](https://apis.alfaview.com/v2/docs/operations/UpdateLanguageSettings.md): Updates the language settings of a room.
- [List Available Languages](https://apis.alfaview.com/v2/docs/operations/ListAvailableLanguages.md): Lists the languages available for transcription and translation.
- [Regenerate Passcode](https://apis.alfaview.com/v2/docs/operations/RegeneratePasscode.md): Generates a new passcode for a room.
- [Get Passcode](https://apis.alfaview.com/v2/docs/operations/GetPasscode.md): Gets the passcode for a room.
- [Get File Share Settings](https://apis.alfaview.com/v2/docs/operations/GetRoomFileShareSettings.md): Gets the file share settings of a room.
- [Update File Share Settings](https://apis.alfaview.com/v2/docs/operations/UpdateRoomFileShareSettings.md): Updates the file share settings of a room.
- [Get File Share Limits](https://apis.alfaview.com/v2/docs/operations/GetRoomFileShareLimits.md): Gets the storage limits for file sharing in a room.

## Meetings

- [List Own Meetings](https://apis.alfaview.com/v2/docs/operations/ListOwnMeetings.md): Lists meetings created by the user authenticated via the access token in the Authorization header.
- [Get Own Meeting](https://apis.alfaview.com/v2/docs/operations/GetOwnMeeting.md): Gets a meeting created by the user authenticated via the access token in the Authorization header.
- [Create Meeting](https://apis.alfaview.com/v2/docs/operations/CreateMeeting.md): Creates a meeting.
- [Update Meeting](https://apis.alfaview.com/v2/docs/operations/UpdateMeeting.md): Updates a meeting.
- [Cancel Meeting](https://apis.alfaview.com/v2/docs/operations/CancelMeeting.md): Cancels a meeting.

## Guests

- [List Guest Links](https://apis.alfaview.com/v2/docs/operations/ListGuestLinks.md): Lists guest links.
- [List Guest Links for a Room](https://apis.alfaview.com/v2/docs/operations/ListGuestLinksForRoom.md): Lists guest links for a room.
- [Get Guest Link](https://apis.alfaview.com/v2/docs/operations/GetGuestLink.md): Gets a single guest link.
- [Create Guest Links](https://apis.alfaview.com/v2/docs/operations/CreateGuestLinks.md): Creates guest links for a room.
- [Update Guest Link](https://apis.alfaview.com/v2/docs/operations/UpdateGuestLink.md): Updates a guest link.
- [Delete Guest Link](https://apis.alfaview.com/v2/docs/operations/DeleteGuestLink.md): Deletes a guest link.
- [Authenticate a Guest (Guest Link)](https://apis.alfaview.com/v2/docs/operations/AuthenticateGuestLink.md): Tries to authenticate a guest link guest via access key.
- [List Group Links](https://apis.alfaview.com/v2/docs/operations/ListGroupLinks.md): Lists group links.
- [List Group Links for Room](https://apis.alfaview.com/v2/docs/operations/ListGroupLinksForRoom.md): Lists group links for a room.
- [Get Group Link](https://apis.alfaview.com/v2/docs/operations/GetGroupLink.md): Gets a single group link.
- [Create Group Links](https://apis.alfaview.com/v2/docs/operations/CreateGroupLink.md): Creates group links for a room.
- [Update Group Link](https://apis.alfaview.com/v2/docs/operations/UpdateGroupLink.md): Updates a group link.
- [Delete Group Link](https://apis.alfaview.com/v2/docs/operations/DeleteGroupLink.md): Deletes a group link.
- [Authenticate a Guest (Group Link)](https://apis.alfaview.com/v2/docs/operations/AuthenticateGroupLink.md): Tries to authenticate a group link guest via access key.

## Reports

- [List Statistics](https://apis.alfaview.com/v2/docs/operations/ListStatistics.md): Lists statistics for provided filters grouped by time periods depending on the corresponding query parameter.
- [List Attendances](https://apis.alfaview.com/v2/docs/operations/ListAttendances.md): Lists attendances at a room during a time period.

## Users

- [Invite User](https://apis.alfaview.com/v2/docs/operations/InviteUser.md): Invites a user to the company of the requester.
- [List Users](https://apis.alfaview.com/v2/docs/operations/ListUsers.md): Lists all users in the company.
- [Get Own User](https://apis.alfaview.com/v2/docs/operations/GetOwnUser.md): Returns the profile of the requesting user.
- [Update Own User](https://apis.alfaview.com/v2/docs/operations/UpdateUser.md): Updates the requester's user information.
- [Delete User](https://apis.alfaview.com/v2/docs/operations/DeleteUser.md): Deletes a user.
- [Get own company](https://apis.alfaview.com/v2/docs/operations/GetOwnCompany.md): Returns the company of the requester.

## Permissions

- [List Permission Groups](https://apis.alfaview.com/v2/docs/operations/ListPermissionGroups.md): Lists permission groups.
- [List Room Permissions](https://apis.alfaview.com/v2/docs/operations/ListPermissions.md): Lists permissions applied in a room.
- [Create Room Permissions](https://apis.alfaview.com/v2/docs/operations/CreatePermissions.md): Creates permissions for a user that are applied in a room.
- [Update Room Permissions](https://apis.alfaview.com/v2/docs/operations/UpdatePermissions.md): Updates permissions of a user that are applied in a room.
- [Delete Room Permissions](https://apis.alfaview.com/v2/docs/operations/DeletePermissions.md): Deletes permissions of a user that are applied in a room.

## Files

- [Get File Share Settings](https://apis.alfaview.com/v2/docs/operations/GetRoomFileShareSettings.md): Gets the file share settings of a room.
- [Update File Share Settings](https://apis.alfaview.com/v2/docs/operations/UpdateRoomFileShareSettings.md): Updates the file share settings of a room.
- [Get File Share Limits](https://apis.alfaview.com/v2/docs/operations/GetRoomFileShareLimits.md): Gets the storage limits for file sharing in a room.

## Optional

- [Complete documentation in one file](https://apis.alfaview.com/v2/docs/llms-full.txt): All pages of this index concatenated (llms-full.txt)
- [Interactive documentation](https://apis.alfaview.com/v2/docs/openapi): HTML, rendered with Stoplight Elements
- [OpenAPI 3.1 specification](https://apis.alfaview.com/v2/docs/openapi.yaml): Also available as openapi.json
- [OpenAPI 3.0.3 specification](https://apis.alfaview.com/v2/docs/openapi-3.0.yaml): Also available as openapi-3.0.json