1. Base Endpoint
All requests must go to:
https://api.worldsquashofficiating.com/api/users
2. Authentication
Include your issued WSO license key in the request header:
Key: X-License-Key Value: YOUR-LICENSE-KEY
Without a valid license key, your request will be denied.
3. Request Limits
- Each license key is limited to a certain amount of requests per month
- Usage resets automatically on the 1st of each month
- If you exceed the limit, you’ll receive:
429 Monthly limit reached
4. How to Query
Use POST requests with the following structure.
Header Example: Key: Content-Type Value: application/json Key: X-License-Key Value: YOUR-LICENSE-KEY
Body Example (using ngb_id):
{
"ngb_id": "000000000"
}
Body Example (using psa_membership_id):
{
"psa_membership_id": "000000000"
}
Body Example (using psa_membership_id_2025):
{
"psa_membership_id_2025: "000000000"
}
Body Example (with all IDs):
{
"ngb_id": "000000000",
"psa_membership_id": "000000000",
"psa_membership_id_2025": "000000000",
}
Replace the id with the actual NGB/PSA ID of the user you want to query. This needs to be added by the user to their WSO profile, their referee profile can then be accessed by their unique NGB/PSA ID.
- Replace the id with the actual NGB/PSA ID of the user you want to query.
- In order to query a user, they will need to have added their NGB/PSA user ID to their WSO profile.
- ID's can be sent together in the same call, NGB will takepreference.
5. Activation
Your license key is automatically activated the first time you use it.
No manual steps required.
6. Common Errors
- 401 - Missing license key
- 403 - Invalid or revoked license key
- 429 - Quota exceeded
7. Support
If you need help or believe your license has been blocked in error, please contact:
