We are listing the available API endpoints for habitate.io. These can be used to build additional feature and create linked services around your community.

In case you need more help you can get in touch with the team, developer-support at habitate.io

Create a user

Endpoint

POST /api/v1/users

Body parameters

Name	Type	Req?	Comments
first_name	string	Y
middle_name	string	N
last_name	boolean	N
username	integer	N	case-insensitive value. Can not have spaces or special characters.
email	integer	Y
sso_id	boolean	N	If using sso then make sure to provide this value else there is a possibility of duplicate account creation.
user_avatar	string	N
lang	string	N	Default is `en`. Please follow this format
timezone	string	N	Default is `UTC`. Supported list

Additional Notes

Make sure the email is verified before creating the user.
New Language support will be added based on requests.

Please validate your use case before creating users via api as this is only reserved for certain cases.

Response parameters

{
  "user_id": 200,
  "username": "string",
  "user_avatar": "string",
  "first_name": "string",
  "last_name": "string",
  "middle_name": "string",
  "sid": "string",
  "role_id": 0,
  "is_bot": true,
  "user_status": "string",
  "email": "string",
  "msid": "string",
  "created_at": "2022-03-23T05:23:19.845Z",
  "last_modified_at": "2022-03-23T05:23:19.845Z"
}