Open API v2 will be deprecated on April 3, 2023. Please begin transitioning to Open API v3 as soon as possible. As of September 29, 2022 all new apps will only be permitted to use Open API v3.
- ApiMethod
- BillCharge
- BillingOverview
- BillPayment
- Cart
- CartListing
- Country
- Coupon
- DataType
- FavoriteListing
- FavoriteUser
- Feedback
- FeedbackInfo
- ForumPost
- Guest
- GuestCart
- ImageType
- Ledger
- LedgerEntry
- Listing
- ListingFile
- ListingImage
- ListingInventory
- ListingOffering
- ListingProduct
- ListingTranslation
- ListingVariationImage
- Money
- ParamList
- Payment
- PaymentAccountLedgerEntry
- PaymentAdjustment
- PaymentAdjustmentItem
- PaymentTemplate
User
Overview
Represents a single user of the site.
Fields
Field | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
user_id |
public |
none | int |
The user's numeric ID. This is also valid as the user's shop ID. |
login_name |
public |
none | string |
The user's login name. |
primary_email |
private |
|
string |
The user's primary email address. |
creation_tsz |
public |
none | float |
The date and time the user was created, in epoch seconds. |
referred_by_user_id |
public |
none | int |
The numeric ID of the user that referred this user. |
feedback_info |
public |
none |
|
An associative array of feedback totals for the user. |
awaiting_feedback_count |
private |
none | int |
The total number of transactions the user has available for a new review. |
use_new_inventory_endpoints |
private |
none | boolean |
Should this user's listings be created or edited using the new Inventory endpoints? |
Associations
Association | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
Shops |
public |
none |
|
An array of shops that belong to the user. |
Profile |
public |
none |
|
The user's public profile. |
BuyerReceipts |
private |
|
|
An array of receipts for listings this user has purchased. |
BuyerTransactions |
private |
|
|
An array of transactions (sold listings) this user has purchased. |
Addresses |
private |
|
|
A user's Addresses. |
Methods
findAllUsers
Method Name | findAllUsers |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Finds all Users whose name or username match the keywords parameter. | ||||||||||||||||||||
HTTP Method | GET |
||||||||||||||||||||
URI | /users |
||||||||||||||||||||
Parameters |
|
||||||||||||||||||||
Requires OAuth | N |
||||||||||||||||||||
Permission Scope | none |
getUser
Method Name | getUser |
||||||||
---|---|---|---|---|---|---|---|---|---|
Synopsis | Retrieves a User model object. | ||||||||
HTTP Method | GET |
||||||||
URI | /users/:user_id |
||||||||
Parameters |
|
||||||||
Requires OAuth | N |
||||||||
Permission Scope | none |
findAllUsersForTeam
Method Name | findAllUsersForTeam |
||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Returns a list of users for a specific team | ||||||||||||||||||||||||
HTTP Method | GET |
||||||||||||||||||||||||
URI | /teams/:team_id/users/ |
||||||||||||||||||||||||
Parameters |
|
||||||||||||||||||||||||
Requires OAuth | N |
||||||||||||||||||||||||
Permission Scope | none |
getCirclesContainingUser
Method Name | getCirclesContainingUser |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Returns a list of users who have circled this user | ||||||||||||||||||||
HTTP Method | GET |
||||||||||||||||||||
URI | /users/:user_id/circles |
||||||||||||||||||||
Parameters |
|
||||||||||||||||||||
Requires OAuth | N |
||||||||||||||||||||
Permission Scope | none |
getConnectedUser
Method Name | getConnectedUser |
||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Returns details about a connection between users | ||||||||||||||||||||||||
HTTP Method | GET |
||||||||||||||||||||||||
URI | /users/:user_id/circles/:to_user_id |
||||||||||||||||||||||||
Parameters |
|
||||||||||||||||||||||||
Requires OAuth | N |
||||||||||||||||||||||||
Permission Scope | none |
unconnectUsers
Method Name | unconnectUsers |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Removes a user (to_user_id) from the logged in user's (user_id) circle | ||||||||||||
HTTP Method | DELETE |
||||||||||||
URI | /users/:user_id/circles/:to_user_id |
||||||||||||
Parameters |
|
||||||||||||
Requires OAuth | Y |
||||||||||||
Permission Scope |
|
getConnectedUsers
Method Name | getConnectedUsers |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Returns a list of users that are in this user's cricle | ||||||||||||||||||||
HTTP Method | GET |
||||||||||||||||||||
URI | /users/:user_id/connected_users |
||||||||||||||||||||
Parameters |
|
||||||||||||||||||||
Requires OAuth | N |
||||||||||||||||||||
Permission Scope | none |
connectUsers
Method Name | connectUsers |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Adds user (to_user_id) to the user's (user_id) circle | ||||||||||||
HTTP Method | POST |
||||||||||||
URI | /users/:user_id/connected_users |
||||||||||||
Parameters |
|
||||||||||||
Requires OAuth | Y |
||||||||||||
Permission Scope |
|