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
UserProfile
Overview
Represents a user's public profile. Generally, this is the information available for a member as "Public Profile" on Etsy.com
Deprecated Fields
As of March 28, 2011, the "User" and "Shops" associations of UserProfile no longer exist in the API. Instead, query the User resource directly, using the Etsy member's login name, and/or use the Shops association of User.
Fields
Field | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
user_profile_id |
public |
none | int |
The numeric ID of the user profile.
Deprecated: Do not use |
user_id |
public |
none | int |
The numeric ID of the user this profile corresponds to. |
login_name |
public |
none | string |
The login name of the user that owns this profile. |
bio |
public |
none | string |
The bio of the user. |
gender |
public |
none | string |
The gender of the user. |
birth_month |
public |
none | string |
The birth month of the user. |
birth_day |
public |
none | string |
The birth day of the user. |
birth_year |
private |
|
string |
The birth year of the user. |
join_tsz |
public |
none | float |
The date and time the user was created, in epoch seconds. |
materials |
public |
none | string |
A list of the user's favorite materials. |
country_id |
public |
none | int |
The numeric ID of the user's country. |
region |
public |
none | string |
The user's region (free-form text) |
city |
public |
none | string |
The user's city (free-form text) |
location |
public |
none | string |
The user's location (self-supplied, free-form text).
Deprecated: Do not use. |
avatar_id |
public |
none | int |
The numeric ID of this user's avatar image. |
lat |
private |
|
float |
The latitude of the user. |
lon |
private |
|
float |
The longitude of the user. |
transaction_buy_count |
public |
none | int |
The number of bought items for this user. |
transaction_sold_count |
public |
none | int |
The number of sold transactions for this user. |
is_seller |
public |
none | boolean |
If the user is a seller or not. Value true if user is a seller. |
image_url_75x75 |
public |
none | string |
The URL to the user's avatar image; dimensions 75px square. |
first_name |
public |
none | string |
The first name of the user. |
last_name |
public |
none | string |
The last name of the user. |
Associations
Association | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
Country |
public |
none |
|
The country in which the user lives. |
Methods
findUserProfile
Method Name | findUserProfile |
||||||||
---|---|---|---|---|---|---|---|---|---|
Synopsis | Returns the UserProfile object associated with a User. | ||||||||
HTTP Method | GET |
||||||||
URI | /users/:user_id/profile |
||||||||
Parameters |
|
||||||||
Requires OAuth | N |
||||||||
Permission Scope | none |
updateUserProfile
Method Name | updateUserProfile |
||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis |
Updates the UserProfile object associated with a User. Notes:
|
||||||||||||||||||||||||||||||||||||||||||||
HTTP Method | PUT |
||||||||||||||||||||||||||||||||||||||||||||
URI | /users/:user_id/profile |
||||||||||||||||||||||||||||||||||||||||||||
Parameters |
|
||||||||||||||||||||||||||||||||||||||||||||
Requires OAuth | Y |
||||||||||||||||||||||||||||||||||||||||||||
Permission Scope |
|