PALs

Check Conferencing Username Availability

Check whether a conferencing username is available on tavusinvite.com before creating or patching a PAL.

See Google Meet / Zoom / Teams.

get/v2/pals/check-username

Request

  • Base URL
    https://tavusapi.com
  • URL
    https://tavusapi.com/v2/pals/check-username
  • Auth
    API key in header x-api-key

Query parameters

usernamestring required

The username to check. Case-insensitive; stored lowercase.

Response

Availability result

availableboolean

true when the username can be used on tavusinvite.com.

reasonstring

Present when available is false.

Example response

{
  "available": true,
  "reason": "Username is already taken."
}

Changes

No recorded changes to this operation across all 2 revisions of this API.