- Compatible XF 2.x versions
- 2.3
- Additional requirements
- Only tested on Xenforo 2.3, but maybe works in other versions
- Visible branding
- No
Custom User Field API
This XenForo 2.3+ addon provides custom API endpoints to retrieve and update users based on Custom User Fields (e.g., finding a user by their game ID).
Features
- Get User by Custom Field: Retrieve user details by filtering with a custom field value.
- Update User by Custom Field: Update user account details (username, email, etc.) by identifying them via a custom field value.
Requirements
- XenForo 2.3.0 or higher.
- A valid API Key with
Installation
1. Upload the
2. Go to your Admin Control Panel -> Add-ons.
3. Install Custom User Field API.
API Endpoints
1. Get Users by Custom Field
GET
Parameters:
-
Example:
2. Update User by Custom Field
POST
Parameters:
-
-
-
-
Postman Collection
A
---
Developer: Brais
Web: [https://shoppy.gg/@BraisDev)
Support: [https://xenforo.com/community/membe.../xenforo.com/community/members/brais.295523/)
This XenForo 2.3+ addon provides custom API endpoints to retrieve and update users based on Custom User Fields (e.g., finding a user by their game ID).
Features
- Get User by Custom Field: Retrieve user details by filtering with a custom field value.
- Update User by Custom Field: Update user account details (username, email, etc.) by identifying them via a custom field value.
Requirements
- XenForo 2.3.0 or higher.
- A valid API Key with
user scopes (and user:write for updates).Installation
1. Upload the
BraisDev folder to your src/addons directory.2. Go to your Admin Control Panel -> Add-ons.
3. Install Custom User Field API.
API Endpoints
1. Get Users by Custom Field
GET
api/users-by-field/Parameters:
-
custom_fields[field_id]: The value to search for.Example:
GET /api/users-by-field/?custom_fields[game_id]=10502. Update User by Custom Field
POST
api/users-by-field/updateParameters:
-
criteria[custom_fields][field_id]: The custom field to use to find the user.-
username: (Optional) New username.-
email: (Optional) New email.-
custom_fields[other_field]: (Optional) Update other custom fields.Postman Collection
A
postman_collection.json file is included in this addon's folder. You can import it into Postman to test the endpoints immediately.---
Developer: Brais
Web: [https://shoppy.gg/@BraisDev)
Support: [https://xenforo.com/community/membe.../xenforo.com/community/members/brais.295523/)