Users API

API v1.0

General Response Structure

All responses are in JSON format and contain either data or error. Successful responses will return a data field containing the requested information.

Request URLs

Method	url	Description	params	Return
POST	/api/v1/users	Registers users	UserRequest	UserResponse
POST	/api/v1/user	Logs a user in	username and password	UserResponse
GET	/api/v1/user	Get user information	api_token	UserResponse
PUT	/api/v1/user	Update user information	api_token UserRequest without password	UserResponse
PATCH	/api/v1/user/password	Update user password	api_token password	String message

Data Types

name	description
UserRequest	name Required String email Required String password Required String zipcode Optional String is_anonymous Optional Boolean (defaults to false) is_over_thirteen Required Boolean
UserResponse	name String email String api_token String zipcode String is_anonymous Boolean is_over_thirteen Boolean