Each user is accessed via /api/user .
Complete details in UserProperties.
The unique id for this user. It will never change.
user
Another unique way of identifying a user. However, this can be changed by an admin or the user himself.
The name that this user goes by in the real world. Example: Andy Dufresne
An email address associated with this user.
Which field should be used to determine a display name.
Defaults to username.
Options are username,
real_name,
email.
Only used for display purposes.
See also use_as_display_name.
A boolean indicating whether the user has admin rights on the server.
The amount of shop credit owned by this user.
The amount of crafter points for this user.
A boolean indicating whether the user has been granted the privilege of checking out using an invoice.
A date when the user last logged in to the system.
A date when the user was created.
A date when the user's account was last updated.
The id of the Folder where this user can upload files. When a user is created, a separate Folder is made for them.
The unique id of the avatar for this user.
The URI of the avatar for this user.
Determines how a user's profits will be distributed.
Defaults to shop_credit.
Options are: shop_credit and paypal and none.
The email address of the user's PayPal account.
Only used if payout_via is set to paypal.
The starting Folder where this user can upload files.
The list of Designers this user controls.
A list of DesignerAssociate relationships that this user is a part of.
A list of Designer this user is an associate of.
See also designerassociates.
The list of Carts the user has created.
The list of Receipts for previous orders the user has created.
The list of Reviews the user has created.
The list of Wishlists the user has created.
The list of root Folders controlled by this user.
More specifically,
those directly under the root_folder.
The list of Games controlled by this user through their Designers.
The list of WebHooks you have subscribed to.
The methods used to fetch and manipulate users.
Provides a list of the options that can be used to fill out various fields when creating or updating a user.
GET /api/user/_options
Returns:
{
"use_as_display_name" : [...]
}
NOTE: You can also get this data by adding _include_options=1 to the parameter list when fetching a user.
PUT /api/user/xxx
Required. The unique session id provided by a Session method.
Required.
A string to be set as the password. Must be at least 6 characters. Required.
Optional.
Required.
Optional.
Optional. The id of a File with a 300x300 image in it.
Can only be done by an admin or the user itself.
Returns:
{
"id" : "xxx",
"username" : "andy",
...
}
DELETE /api/user/xxx
Required. The unique session id provided by a Session method.
Can only be done by an admin or the user itself.
Returns:
{
"success" : 1
}
GET /api/user/xxx
Optional. The unique session id provided by a Session method.
Can by done by anybody.
Returns:
{
"id" : "xxx",
"username" : "andy",
...
}
GET /api/user
A partial username or email address.
Returns:
{
"items" : [
{
"id" : "xxx",
"display_name" : "Andy",
...
},
...
],
"paging" : {}
}
GET /api/user/xxx/addresses
{
"items" : [
{
"id" : "xxx",
"name" : "Andy Dufresne",
"state" : "ME"
...
},
...
],
"paging" : {}
}
POST /api/user/xxx/get_folder
This is a utility method. If the requested Folder already exists by name, then it returns that folder. Otherwise, it returns named folder.