curl -sS 'https://matrix.example.com/_synapse/admin/v1/username_available?username=alice' -H "Authorization: Bearer $ACCESS_TOKEN"

Category: Matrix & Synapse

curl -sS 'https://matrix.example.com/_synapse/admin/v1/username_available?username=alice' -H "Authorization: Bearer $ACCESS_TOKEN"

Check if a username is free to register

Answers whether the localpart alice is available and valid for registration, returning {"available":true} or false. Unlike the client register/available endpoint it works even when registration is disabled, which makes it handy for pre-checking names in onboarding scripts. It does not create the user; use register_new_matrix_user for that.
Looking for more? Search all 7,657 commands — works offline, in English or Spanish, and fixes typos.