Users

>>>

GET /api/v1/users/:id/list_fave_locations.json
Fetch list of favorite locations

Fetch list of favorite locations

Supported Formats

json

Params

Param name Description
id
required

ID of user

Validations:

  • Must be a Integer
>>>

GET /api/v1/users/total_user_count.json
Fetch total count of users

Fetch total count of users

Supported Formats

json
>>>

POST /api/v1/users/:id/add_fave_location.json
Adds a location to your fave list

Adds a location to your fave list

Supported Formats

json

Params

Param name Description
id
required

ID of user

Validations:

  • Must be a Integer
location_id
required

ID of location to add

Validations:

  • Must be a Integer
>>>

POST /api/v1/users/:id/remove_fave_location.json
Removes a location from your fave list

Removes a location from your fave list

Supported Formats

json

Params

Param name Description
id
required

ID of user

Validations:

  • Must be a Integer
location_id
required

ID of location to remove

Validations:

  • Must be a Integer
>>>

POST /api/v1/users/auth_details.json
Fetch auth info for a user

This info includes the user’s API token. Send login and password in the request body; GET with query params is deprecated because it exposes the password in URLs and logs.

Params

Param name Description
login
required

User’s username or email address

Validations:

  • Must be a String
password
required

User’s password

Validations:

  • Must be a String
>>>

POST /api/v1/users/forgot_password.json
Password retrieval

Reset a forgotten password

Params

Param name Description
identification
required

A username or email address

Validations:

  • Must be a String
>>>

POST /api/v1/users/resend_confirmation.json
Resend confirmation

Resend an account confirmation

Params

Param name Description
identification
required

A username or email address

Validations:

  • Must be a String
>>>

POST /api/v1/users/signup.json
Signup a new user

Signup a new user for the PBM

Params

Param name Description
username
required

New username

Validations:

  • Must be a String
email
required

New email address

Validations:

  • Must be a String
password
required

New password

Validations:

  • Must be a String
confirm_password
required

New password confirmation

Validations:

  • Must be a String
>>>

GET /api/v1/users/:id/profile_info.json
Fetch profile info for a user

Supported Formats

json

Params

Param name Description
id
required

ID of user

Validations:

  • Must be a Integer
new_score_list_only
optional

When present, the old high score list is gone (recent 50); only showing the new list of highest high score per machine, all scores per machine, and average and count

Validations:

  • Must be a Integer
life_list
optional

When present, returns the life list (all machines the user has played) with associated score data instead of profile_machine_scores_stats

Validations:

  • Must be a Integer
life_list_ids_only
optional

When present, returns only id and life_list_machine_ids (the machine_ids on the user’s life list), skipping all other profile_info fields. Takes precedence over life_list and new_score_list_only.

Validations:

  • Must be a Integer
>>>

GET /api/v1/users/life_list_info.json
Query life list membership

When no params are provided, returns all machines on at least one life list, sorted by count descending.

Supported Formats

json

Params

Param name Description
by_machine_id
optional

Machine ID to query

Validations:

  • Must be a Integer
by_user_id
optional

User ID to query

Validations:

  • Must be a Integer
>>>

POST /api/v1/users/:id/add_life_list_machine.json
Add a machine to your life list

Supported Formats

json

Params

Param name Description
id
required

ID of user

Validations:

  • Must be a Integer
machine_id
required

ID of machine to add

Validations:

  • Must be a Integer
>>>

POST /api/v1/users/:id/remove_life_list_machine.json
Remove a machine from your life list

Supported Formats

json

Params

Param name Description
id
required

ID of user

Validations:

  • Must be a Integer
machine_id
required

ID of machine to remove

Validations:

  • Must be a Integer
>>>

DELETE /api/v1/users/:id
Delete a user account

Permanently delete your user account

Supported Formats

json

Params

Param name Description
id
required

ID of user

Validations:

  • Must be a Integer
>>>

POST /api/v1/users/:id/update_email
Update email address

Update email address for a user

Supported Formats

json

Params

Param name Description
id
required

ID of user

Validations:

  • Must be a Integer
current_password
required

Current password

Validations:

  • Must be a String
email
required

New email address

Validations:

  • Must be a String
>>>

POST /api/v1/users/:id/update_password
Update password

Update password for a user

Supported Formats

json

Params

Param name Description
id
required

ID of user

Validations:

  • Must be a Integer
current_password
required

Current password

Validations:

  • Must be a String
password
required

New password

Validations:

  • Must be a String
password_confirmation
required

New password confirmation

Validations:

  • Must be a String
>>>

POST /api/v1/users/:id/update_user_flag
Set a flag icon for your user

Supported Formats

json

Params

Param name Description
id
required

ID of user

Validations:

  • Must be a Integer
flag
optional

ISO code for flag

Validations:

  • Must be a String