REST API: Check Username Availability

Anonymous User

Published: 1/29/2016

Grace Kamau

Updated: 9/21/2020

0 (0votes)

Check Username Availability

Check if a username is available for use or not. Valid for Communifire version 5.2 and above.

HTTP Method

GET

Response Format

JSON

Requires Authentication?

YES

Product Version

5.2 and above

Required Parameters	How to use	Description
API Key	Used in the request URL: &token=x OR Set in header: request.Headers.Add(Rest-Api-Key, x)	Communifire REST API key for the Communifire portal you are making the call for.
Username	&Username=x - Used in the request URL as a query parameter	User's desired username.

True/false is returned as ResponseMessage.


{
    "IsError":false,
    "ResponseMessage":"True",
    "ResponseData":"simon"
}

Please Note The content type that you pass in the header of your request should be application/json.