FaxStore

Prerequisites
Installation & Setup
API
Config File
Developer Mode
Developer Tools
Enable Debug Mode
Events
Extensions
Features
Integrations
License System Extension
Permissions
Updating FaxStore

Weblutions Documentation > FaxStore > API > Accounts

Accounts

The Accounts API for FaxStore provides a comprehensive solution for managing user accounts, including creation, deletion, modification, and retrieval of account details. This API ensures secure and efficient handling of user information and authentication processes across the platform.

GET /api/account/:id

Returns the provided user information.

Parameters:

authorization[Header] A valid API token
id[URL] The users displayed ID, or internal database ID

Response: [Expand]

POST /api/account

Creates a user with the specified data. The account password cannot be set, it is generated and the user will have to reset the password.

Parameters:

authorization[Header] A valid API token
id[URL] The users displayed ID, or internal database ID
username[Body] The users display name
email[Body] The users email
type[Body] Account type, must be one of; local, discord, github, google
id[Body] Optional, the user ID, if not provided one will be generated. If this is a Google, Discord, or GitHub account the services ID should be used
image[Body] Optional, users profile image
bio[Body] Optional, bio for users account, feature unused by default
tebexUsername[Body] Optional, Tebex registered username
banned[Body] Optional, Boolean for if the user is banned
disabled[Body] Optional, Boolean for if the user is disabled

Response: [Expand]

PATCH /api/account/:id

Updates the user with the provided fields.

Parameters:

authorization[Header] A valid API token
id[URL] The users displayed ID, or internal database ID
id[Body] Optional
username[Body] Optional
image [Body] Optional
email[Body] Optional
bio[Body] Optional
tebexUsername[Body] Optional

Response: [Expand]

DELETE /api/account/:id

Deletes the provided account from FaxStore. This action generally isn't recommended, consider banning the user instead.

Parameters:

authorization[Header] A valid API token
id[URL] The users displayed ID, or internal database ID

Response: [Expand]


Suggest an edit

Review this page

faxes

accounts api