The GetBeaned API

Work in progress

Add an user

POST https://getbeaned.api-d.com/api/users/

This endpoint allows you to upload an user data to the website. This is a required step to be able to add actions. The endpoint will update or create the user automatically.

Headers

Name	Type	Description
Update	boolean	False if we don't want to update the user because the data is stale
Authentication	string	Authentication token supplied on request.

Request Body

Name	Type	Description
discord_default_avatar_url	string	Default Discord CDN URL for the user avatar.
discord_avatar_url	string	Discord CDN URL to the PNG (static) or WEBP (animated) avatar of the user
discord_discriminator	integer	The user Discriminator (Excluding the #)
discord_name	string	Name of the user
discord_id	boolean	Discord user ID
discord_bot	boolean	Please set that to True if the user is a bot

200 Cake successfully retrieved.

{
 'status': 'ok',
 'message': 'User existed in database already',
 'result': '[User representation]'
 }

302 Error when saving the new user

{
    'status': 'error',
    'errors': ['List of errors']
}

API Users Counter

GET https://getbeaned.api-d.com/api/users/<int:guild_id>/<int:user_id>/counters/

Path Parameters

Name	Type	Description
	string

200