Profile

Description

The profile contains a rich set of a user's social data, including school and work information as well as interests and relationships. As with all user data, information available in the profile will be subject to user permissions.

URI

GET returns the profile of a given {guid}. POST updates the profile of a given {guid} with the information in the Updatedprofile Object that is sent in the request body.

https://social.yahooapis.com/v1/user/{guid}/profile

Filters

Search strings for filters must be URI-escaped and UTF-8 encoded. For example, a search string for an email address would have to escape the '@' character to '%40'.

Filtering by GUID

Calling GET on the following URI returns the profiles of the users identified by GUIDs {guid1}, {guid2}, and {guid3}.

https://social.yahooapis.com/v1/users.guid({guid1},{guid2},{guid3})/profile

HTTP Operations Supported

  • GET
  • POST

Query Parameters Supported

  • callback
  • format

Matrix Parameters Supported

  • start
  • count

Scopes Required

  • GET: Read Public - Yahoo Profiles
  • POST: Read/Write Public - Yahoo Profiles
  • POST: Read/Write Public and Private - Yahoo Profiles (Private)

Note

The Read/Write Private Yahoo Profiles scope will provide read and write access to all elements of the Updateprofile Object. The Read/Write Public Yahoo Profiles scope will only provide read and write access to those elements that the user has marked as public or shared with connections. The user's contact information is read-only.

Elements of the Profile Object

Element JSON Data Type XML Schema Data Type Description
birthdate string string Birth date of the profile owner, month, and day.
count number nonNegativeInteger Total number of profiles.
created string dateTime Date resource was created.
declaredInterest string string One interest such the name of a movie.
declaredInterests string Zero or more declaredInterest. Group of interests declared for the category. Each interest is separated by a comma. For example: "movies, hiking, cooking".
displayAge number positiveInteger The proclaimed age chosen by the user, assumed to be public information. There is no check or verification. User can claim any age.
familyName string string Family name of the profile owner.
gender string enum Gender of the profile owner, for displaying updates. Can be one of the following values: "M", "F" or "Unspecified".
givenName string string Given name of the profile owner.
guid string string GUID of the profile owner.
height number positiveInteger Image height.
image Image Object Image Object Image of the profile owner.
imageURL string anyURI The URL to the image of the profile owner. Returns a 192x192 pixeled image.
interestCategory string string Category of the interest, for example, movie.
interests array of Interest Objects Zero of more of Interests Objects Interests of the profile owner.
isConnected boolean boolean Whether the viewer is connected to profile owner.
lang string string Comma-separated list of RFC 4646 basic language ranges in descending priority order.
lastStatusModified string dateTime Time of the last status update.
location string string Proclaimed location of the profile owner. There is no check or verification of this.
lookingFor string enum The type of relationship that profile owner is interested in. The following values are allowed: "FRIENDSHIP", "DATING", "RELATIONSHIP", "NETWORKING", or "OTHER".
memberSince string dateTime Date of ID registration.
message string string Status text of the profile owner.
nickname string string Display name of the profile owner.
phones array of strings one of more Phone Objects The profile owner's collection of phone numbers.
profileURL string anyURI URL of the profile.
relationshipStatus string enum Relationship status of the profile owner. The following values are allowed: "", "SINGLE", "IN A RELATIONSHIP","MARRIED","ENGAGED", or "DIVORCED".
schools array of School Objects Zero or more School Objects Collection of School Objects.
size string string Image size. Should be of the form WxH.
status Status Object Status Object Object containing the profile owner's status.
start number nonNegativeInteger Index of first profile returned.
timezone string timezone Time zones must be identified using the identifiers of the tz database (See http://www.twinsun.com/tz/tz-link.htm). Examples are "America/Los_Angeles" for U.S. Pacific Time, "Europe/Berlin" for Central European Time (with German historic rules), "Asia/Seoul" for Korea Time. The preferred parameter or attribute name is "tz".
total number nonNegativeInteger Number of profiles returned.
updated string dateTime Date resource was last modified.
uri string anyURI The URL to the actual resource.
width number positiveInteger Image width.
works array of Work Objects Zero or more Work Objects Collection of Work Objects.

Elements of the Updateprofile Object

The Updateprofile Object is sent via HTTP POST to update the user's profile information. No elements in the Updateprofile Object are required.

Element JSON Data Type XML Schema Data Type Description
aboutMe string string The profile owner's personal description.
birthdate string string Birth date of the profile owner, month, and day.
displayAge number positiveInteger The proclaimed age chosen by the user, assumed to be public information. There is no check or verification. User can claim any age.
familyName string string Family name of the profile owner.
gender string enum Gender of the profile owner, for displaying updates. Can be one of the following values: "M", "F" or "Unspecified".
givenName string string Given name of the profile owner.
interests array of Interest Objects Zero of more of Interests Objects Interests of the profile owner.
languagesSpoken array of string enum Comma-separated RCF 4647 language priority list of RFC 4646 basic language ranges. Contains language tags in descending priority order.
location string string Proclaimed location of the profile owner. There is no check or verification of this.
lookingFor string enum The type of relationship that profile owner is interested in. The following values are allowed: "FRIENDSHIP", "DATING", "RELATIONSHIP", "NETWORKING", or "OTHER".
message string string Status text of the profile owner.
nickname string string Display name of the profile owner.
relationshipStatus string enum Relationship status of the profile owner. The following values are allowed: "", "SINGLE", "IN A RELATIONSHIP","MARRIED","ENGAGED", or "DIVORCED".
schools array of School Objects Zero or more School Objects Collection of School Objects.
works array of Work Objects Zero or more Work Objects Collection of Work Objects.

Elements of the Interest Object

Element JSON Data Type XML Schema Data Type Description
declaredInterests array of strings string A string consisting of a comma-delimited list of user interests. For example: "Thai food, Italian food, Chinese food".
interestCategory string string The category for the declared interests. For example, the interestCategory for restaurants would be "prfFavFoods".

Elements of the School Object

Element JSON Data Type XML Schema Data Type Description
schoolName string string Name of school attended by the profile owner.
schoolType string string Type of school, such as elementary or high school.
schoolYear string positiveInteger Year, in four digits, that profile owner graduated from the school.
city string string City where school is located.
state string string State or province where school is located.
country string string Country of school. Empty or standard list of country codes in ISO 3166: http://www.iso.org/iso/country_codes.
startDate string dateTime Date that profile owner began to attend this school.
endDate string dateTime Date that profile owner left the school.
id number positiveInteger ID of the object.

Elements of the Work Object

Element JSON Data Type XML Schema Data Type Description
address string string Street address of company location.
city string string City of work location.
country string string Country of work location. Empty or standard list of country codes in ISO 3166: http://www.iso.org/iso/country_codes
endDate string date Date that profile owner ended work at this company.
id number string ID of object.
postalCode string string Zip or postal code of work location.
startDate string date Date the profile owner began work at this company.
state string string State or province of work location.
title string string Title of employment at this place of work.
workName string string Company name where the profile owner has worked.

JSON Syntax for Profile Object

JSON Syntax for Updateprofile Object

Example JSON Response Body for GET Profile

Example XML Response Body for GET Profile

Example JSON Request Body for POST Profile

Table of Contents