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.

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

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

{ 
  "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": 
    [ 
      <a class="link" href="work-profile-resource.html#workObjectJsonSyntax" title="JSON Syntax for Work Object">Work Object 1</a>, 
      Work Object 2, 
      ...
    ], 
    "schools": 
    [
      <a class="link" href="school-profile-resource.html#schoolObjectJsonSyntax" title="JSON Syntax for School Profile Object">School Object 1</a>,
      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
  } 
}

JSON Syntax for Updateprofile Object

{
  "updateprofile": 
  {
    // Display name of the profile owner      
    "nickname" : "string",
    // Age of the profile owner
    "displayAge" : number,
    // Gender of the profile owner      
    // Possible values: "M" | "F" | "UNSPECIFIED"    
    "gender" : "string" ,    
    // Location of the profile owner 
    "location" : "string", 
    // Given (first) name of the profile owner                   "givenName" : "string", 
    // Family (last) name of the profile owner        
    "familyName" : "string",        
    // Array of Work Objects 
    "works": 
    [
      <a class="link" href="extended-profile-resource.html#workObject" title="Elements of the Work Object">Work Object 1</a>,
      Work Object 2,
      ...  
    ],
    // Array of School Objects      
    "schools": 
    [
      <a class="link" href="extended-profile-resource.html#schoolObject" title="Elements of the School Object">School Object 1</a>,
      School Object 2,
      ...
    ],
    "relationshipStatus":  
    [
      // Allowed values: 
      // "SINGLE","DATING", "RELATIONSHIP","ENGAGED",
      // "MARRIED", "DIVORCED","COMPLICATED", "" 
      "string",
      "string",
      ...
    ]

"lookingFor": 
    [
      // Type of relationship profile owner is seeking.
      // Allowed values:
      // "FRIENDSHIP","DATING","RELATIONSHIP","NETWORKING",
      // "OTHER"
      "string",
      "string",
      ...
    ],
    "languagesSpoken": 
    [
      // Languages  the profile owner speaks.
      "string",
      "string",
      ...
    ],
    "interests" :               
    [        
      // Interests of the profile owner
      {
        interestCategory: "string",                                  
        declaredInterests: 
        [
          "string",
          "string",
          ...
        ]
      }, 
      ...
    ]

// Birthdate of the profile owner (m/d)       
    "birthdate": "string",
    "aboutMe" : "string" 
  }
}

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":
        [
          "Ratatouille"
        ], 
        "interestCategory": "prfFavMovies" 
      },
      {
        "declaredInterests": null,
        "interestCategory": "prfFavFutureMovies"
      }, 
      { 
        "declaredInterests":
        [
          ""
        ], 
        "interestCategory": "prfFavBooks" 
      },
      {
        "declaredInterests": null,
        "interestCategory": "prfFavFutureBooks"
      }, 
      { 
        "declaredInterests":
        [
          ""
        ], 
        "interestCategory": "prfFavQuotes" 
      }, 
      { 
        "declaredInterests":
        [
          "Indian", 
          "Ethiopean"
        ], 
        "interestCategory": "prfFavFoods" 
      }, 
      { 
        "declaredInterests":
        [
          "Britain", 
          "California"
        ], 
        "interestCategory": "prfFavPlaces" 
      }, 
      {
        "declaredInterests": null,
        "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/>
    <interestCategory>prfFavFutureMovies</interestCategory>    </interests>
  <interests>
    <declaredInterests>Catcher in the Rye</declaredInterests>
    <interestCategory>prfFavBooks</interestCategory>
  </interests>
  <interests>
    <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/>
    <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>

Example JSON Request Body for POST Profile

{
  "updateprofile": 
  {
    "nickname": "tommy",
    "displayAge": 31,
    "gender": "M",
    "location": "Chicago",
    "givenName": "Tom", 
    "familyName": "Johnson",
    "works": 
    [
      {
        "workName": "Facemesh",
        "title": "Database Administrator",
        "current":"true",
        "address": "17 Hovel Drive"   
        "city": "Pleasantville",
        "state": "CA",
        "postalCode": "94087",
        "country": "US",
        "startDate" : "date",
        "endDate": "date",
        "id": "22" 
      }
    ],
    "schools": 
    [
     {
       "schoolName": "UC Bertley",
       "schoolType": "university",
       "schoolMajor": "economics", 
       "schoolYear": 1987, 
       "current": "false"
       "city": "Bertley",
       "state": "CA",
       "country": "US",
       "startDate": "date", 
       "endDate": "date",  
       "id": "66" 
      } 
    ],
    "websites": 
    [ 
       "http://myblog.com",
       "http://mybusiness.com"
    ],
    "addresses":
    [
      {
        "type": "HOME",               
        "street": "11 Elias Street", 
        "city": "Smithtown",        
        "state": "CA",             
        "postalCode": "97891",    
        "country": "US",         
        "current": "true",      
        "id": "101"         
      }
    ],
    "phones":
    [
      {
        "type": "HOME", 
        "number": "408-999-9999",
        "primary": "true", 
        "id": "9911" 
      } 
    ],
    "ims":
    [
      {
        "type": "Yahoo!", 
        "handle": "tommy31",
        "id": "1199"      
      }
    ],
    "emails": 
    [
      {
        "type": "HOME",
        "handle": "tommy31",
        "primary": "true",
        "id" : "3131"  
      }
    ],
    "relationshipStatus":  
    [
      "SINGLE"
    ]                                                           
    "lookingFor": 
    [
      "FRIENDSHIP"
    ] 
    "languagesSpoken": 
    [
      "enum"
    ],
    "interests":
    [
      {
        interestCategory: "music",                                   
        declaredInterests: 
        [
          "Igor Stravinsky",
          "Lady Gaga"
        ]
      }                                          
    ]
    "profileMode": "PUBLIC",
    "profileHidden": false, 
    "profileStatus" : "ACTIVE",
    "birthdate" : "12/07",
    "aboutMe" : "Looking for friends!"     
  }
}

Yahoo! Developer Network