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}.

http://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}.

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

Last Name Search

Calling GET on the following URI returns the profiles of users whose last name starts with {familyName_prefix_string}.

http://social.yahooapis.com/v1/users.starts(familyName,{family_prefix_string})/profile

Nickname Search

Calling GET on the following URI returns the profiles of users whose nickname starts with {nickname_prefix_string}.

http://social.yahooapis.com/v1/users.starts(nickname,{nickname_prefix_string})/profile

Filtering By Email (Internal-Only) (Draft)

Calling GET on the following URI returns the profiles of users whose email contains the string {email_string}.

http://social.yahooapis.com/v1/users.email({email_string})/profile

HTTP Operations Supported

GET

Query Parameters Supported

callback
format

Matrix Parameters Supported

start
count

Scopes Required

GET:Read (Shared) Yahoo! Profiles

Elements of the Profile and Update Profile Object

Element	JSON Data Type	XML Schema Data Type	Description
`start`	number	nonNegativeInteger	Index of first profile returned.
`total`	number	nonNegativeInteger	Number of profiles returned.
`count`	number	nonNegativeInteger	Total number of profiles.
`guid`	string	string	GUID of the profile owner.
`nickname`	string	string	Display name of the profile owner.
`image`	Image object	Image object	Image of the profile owner.
`size`	string	string	Image size. Should be of the form WxH.
`width`	number	positiveInteger	Image width.
`height`	number	positiveInteger	Image height.
`imageURL`	string	anyURI	The URL to the image of the profile owner. Returns a 192x192 pixeled image.
`profileURL`	string	anyURI	URL of the profile.
`memberSince`	string	dateTime	Date of ID registration.
`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.
`birthdate`	string	string	Birth date of the profile owner, month, and day.
`gender`	string	enum	Gender of the profile owner, for displaying updates. Can be one of the following values: "M", "F" or "Unspecified".
`location`	string	string	Proclaimed location of the profile owner. There is no check or verification of this.
`status`	Status object	Status object	Object containing the profile owner's status.
`message`	string	string	Status text of the profile owner.
`lastStatusModified`	string	dateTime	Time of the last status update.
`isConnected`	boolean	boolean	Whether the viewer is connected to profile owner.
`givenName`	string	string	Given name of the profile owner.
`familyName`	string	string	Family name of the profile owner.
`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.
`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".
`lang`	string	string	Comma-separated list of RFC 4646 basic language ranges in descending priority order.
`relationshipStatus`	string	enum	Relationship status of the profile owner. The following values are allowed: "", "SINGLE", "IN A RELATIONSHIP","MARRIED","ENGAGED", or "DIVORCED".
`lookingFor`	string	enum	The type of relationship that profile owner is interested in. The following values are allowed: "FRIENDSHIP", "DATING", "RELATIONSHIP", "NETWORKING", or "OTHER".
`interests`	array of Interest Objects	Zero of more of Interests Objects	Interests of the profile owner.
`interestCategory`	string	string	Category of the interest, for example, 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".
`declaredInterest`	string	string	One interest such the name of a movie.
`uri`	string	anyURI	The URL to the actual resource.
`created`	string	dateTime	Date resource was created.
`updated`	string	dateTime	Date resource was last modified.

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
`workName`	string	string	Company name where the profile owner has worked.
`title`	string	string	Title of employment at this place of work.
`address`	string	string	Street address of company location.
`city`	string	string	City of work location.
`state`	string	string	State or province of work location.
`postalCode`	string	string	Zip or postal code 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
`startDate`	string	date	Date the profile owner began work at this company.
`endDate`	string	date	Date that profile owner ended work at this company.
`id`	number	string	ID of object.

JSON Syntax for Profile Object

{ 
  "profile": 
  { 
    "guid": "string", 
    "nickname": "string", 
    "image": 
    { 
      "size": "string",          // WxH 
      "width": number, 
      "height": number, 
      "imageUrl": "string"       // URL
    }, 
    "memberSince": "string",    // date   
    "profileUrl": "string",     // URL
    "displayAge": number, 
    "birthdate": "string",      // date 
    "gender": "string",         // "M"|"F"|"UNSPECIFIED" 
    "location": "string", 
    "status": 
    { 
      "message": "string", 
      "lastStatusModified": "string" // date
    } 
    "isConnected": boolean, 
    "givenName": "string", 
    "familyName": "string", 
    "works": 
    [ 
      Work object 1, 
      Work object 2, 
      ...
    ], 
    "schools": 
    [
      School object 1,
      School object 2,
      ... 
    ], 
    "timeZone": "string",           // timezone
    "lang": "string" , 
    "relationshipStatus": "string", 
    "lookingFor": "string"  // "FRIENDSHIP" |"DATING"|"RELATIONSHIP"|"NETWORKING"|"OTHER"
    "interests": 
    [ 
      { 
        interestCategory: "string", 
        declaredInterests: 
        [
          "string",
          "string",
          ...
        ] 
      }, 
      { 
        "interestCategory": "string", 
        declaredInterests": 
        [
          "string",
          "string",
          ...
        ] 
      }, 
      ... 
    ] , 
    "uri": "string",         // URL
    "created": "string",     // date
    "updated": "string"      // date
  } 
}

Example JSON Response Body for GET Profile

{ 
  "profile": 
  {
    "uri":"http:\/\/social.yahooapis.com\/v1\/user\/12345\/profile", 
    "guid": "12345", 
    "created": "2008-08-26T23:35:16Z",
    "familyName": "Edgerton", 
    "gender": "F",
    "givenName": "Samantha",
    "memberSince": "1996-10-09T01:33:06Z",
    "image": 
    { 
      "height": 225,
      "imageUrl": "http:\/\/img.avatars.yahoo.com\/users\/1YfXUc4vMAAEB9IFDbJ_vk45UmUYE==.large.png", 
      "size": "150x225", 
      "width": 150 
    }, 
    "interests": 
    [ 
      { 
        "declaredInterests":
        [
          "Pottery", 
          "Tennis", 
          "Skiing", 
          "Hiking", 
          "Travel", 
          "picnics"
        ], 
        "interestCategory": "prfFavHobbies" 
      }, 
      { 
        "declaredInterests":
        [
          "Celtic"
        ], 
        "interestCategory": "prfFavMusic" 
      }, 
      { 
        "declaredInterests":
        [
          "Ratatouie"
        ], 
        "interestCategory": "prfFavMovies" 
      }, 
      { 
        "declaredInterests":
        [
          ""
        ], 
        "interestCategory": "prfFavFutureMovies" 
      }, 
      { 
        "declaredInterests":
        [
          ""
        ], 
        "interestCategory": "prfFavBooks" 
      }, 
      { 
        "declaredInterests":
        [
          ""
        ], 
        "interestCategory": "prfFavFutureBooks" 
      }, 
      { 
        "declaredInterests":
        [
          ""
        ], 
        "interestCategory": "prfFavQuotes" 
      }, 
      { 
        "declaredInterests":
        [
          "Indian", 
          "Ethiopean"
        ], 
        "interestCategory": "prfFavFoods" 
      }, 
      { 
        "declaredInterests":
        [
          "Britain", 
          "California"
        ], 
        "interestCategory": "prfFavPlaces" 
      }, 
      { 
        "declaredInterests":
        [
          "South America"
        ], 
        "interestCategory": "prfFavFuturePlaces" 
      }, 
      { 
        "declaredInterests":
        [
          ""
        ], 
        "interestCategory": "prfFavAelse" 
      } 
    ], 
    "lang": "en-US", 
    "location": "Palo Alto", 
    "lookingFor": 
    [
      "FRIENDSHIP",
      "NETWORKING"
    ], 
    "nickname": "Sam",
    "profileUrl": "http:\/\/social.yahooapis.com\/v1/user\/profile\/usercard", 
     "relationshipStatus": "MARRIED", 
    "schools": 
    [ 
      { 
        "id": 1, 
        "schoolName": "San Francisco State University",
        "schoolType": "c", 
        "schoolYear": "2005" 
      }, 
      { 
        "id": 2, 
        "schoolName": "Univerity of Massachusetts",
        "schoolType": "c", 
        "schoolYear": "1989" 
      } 
    ], 
    "status": 
    { 
      "lastStatusModified": "2008-08-29", 
      "message": "I&#39;m working"
    }, 
    "timeZone": "America\/Los_Angeles", 
    "works":
    [ 
      { 
        "current": true, 
        "id": 3, 
        "startDate": "2005-06-01", 
        "title": "Documentation Manager", 
        "workName": "Yahoo!" 
      } 
    ], 
    "isConnected": true 
  } 
}

Example XML Response Body for GET Profile

<profile xmlns="http://social.yahooapis.com/v1/schema.rng" xmlns:yahoo="http://www.yahooapis.com/v1/base.rng" yahoo:uri="http://social.yahooapis.com/v1/user/12345/profile">
  <guid>12345</guid>
  <birthdate>3/3</birthdate>
  <created>2008-08-4T17:13:56Z</created>
  <displayAge>27</displayAge>
  <familyName>Edgerton</familyName>
  <gender>F</gender>
  <givenName>Samantha</givenName>
  <image>
    <height>192</height>
    <imageUrl>http://l.yimg.com/us.yimg.com/i/identity/nopic_192.gif</imageUrl>
    <size>192x192</size>
    <width>192</width>
  </image>
  <interests>
    <declaredInterests>Kite surfing, yodeling, hiking, skiing</declaredInterests>
    <interestCategory>prfFavHobbies</interestCategory>
  </interests>
  <interests>
    <declaredInterests>Classical, country and western, rap</declaredInterests>
    <interestCategory>prfFavMusic</interestCategory>
  </interests>
  <interests> 
    <declaredInterests>Clockwork Orange</declaredInterests>
    <interestCategory>prfFavMovies</interestCategory>
  </interests>
  <interests>
    <declaredInterests>WallE</declaredInterests>
    <interestCategory>prfFavFutureMovies</interestCategory>    </interests>
  <interests>
    <declaredInterests>Catcher in the Rye</declaredInterests>
    <interestCategory>prfFavBooks</interestCategory>
  </interests>
  <interests>
    <declaredInterests>Bible</declaredInterests>
    <interestCategory>prfFavFutureBooks</interestCategory>
  </interests>
  <interests>
    <declaredInterests>Tastes like chicken!</declaredInterests>
    <interestCategory>prfFavQuotes</interestCategory>
  </interests>
  <interests>
    <declaredInterests>Kentucky Fried Chicken</declaredInterests>
    <interestCategory>prfFavFoods</interestCategory>
  </interests>
  <interests>
    <declaredInterests>Hawaii</declaredInterests>
    <interestCategory>prfFavPlaces</interestCategory>
  </interests>
  <interests>
    <declaredInterests>Tahiti</declaredInterests>
    <interestCategory>prfFavFuturePlaces</interestCategory>
  </interests>
  <interests>
    <declaredInterests></declaredInterests>
    <interestCategory>prfFavAelse</interestCategory>
  </interests>
  <lang>en-S</lang>
  <memberSince>1996-10-09T 01:33:06Z</memberSince>
  <lookingFor>FRIENDSHIP</lookingFor>
  <lookingFor>NETWORKING</lookingFor>
  <lookingFor>RELATIONSHIP</lookingFor>
  <lookingFor>OTHER</lookingFor>
  <nickname>Jane</nickname>
  <profileUrl>http://profiles.yahoo.com/u/12345</profileUrl>
  <relationshipStatus>MARRIED</relationshipStatus>
  <schools>
    <id>3</id>
    <schoolName>Harvard University</schoolName>
    <schoolType>c</schoolType>
    <schoolYear>2000</schoolYear>
  </schools>
  <timeZone>America/Los_Angeles</timeZone>
  <works>
    <current>false</current>
    <endDate>2006-03-01</endDate>
    <id>1</id>
    <startDate>2003-04-01</startDate>
    <title>QA Engineer</title>
    <workName>Widgets, Inc.</workName>
  </works>
  <works>
    <current>true</current>
    <id>2</id>
    <startDate>2006-04-01</startDate>
    <title>Senior QA Engineer</title> <workName>Sprockets, Inc.</workName>
  </works>
  <isConnected>true</isConnected>
</profile>