profile resource endpoint

URL: /users/<id>/profile.<format>

Supported Methods

GET Get a more extensive set of user properties that can be used to build a user profile page.

Query String Arguments

start-index
Index of the first item to return. The first item in the list has index 1.
max-results
Maximum number of items to return in the list response.

Resource Type

This endpoint returns an object of type UserProfile.

aboutMe (string)
The user's long description or biography, as a free-form string they provided.
avatarLink (ImageLink)
A link to an image representing this user.
displayName (string)
The user's chosen display name.
email (string)
The user's email address. This property is only provided for authenticated requests if the user has shared it with the authenticated application, and the authenticated user is allowed to view it (as with administrators of groups the user has joined). In all other cases, this property is omitted.
followFrameContentUrl (string)
The URL of a widget that, when rendered in an iframe, allows viewers to follow this user. Render this widget in an iframe 300 pixels wide and 125 pixels high.
gender (string)
The user's gender, as they provided it. This property is only provided for authenticated requests if the user has shared it with the authenticated application, and the authenticated user is allowed to view it (as with administrators of groups the user has joined). In all other cases, this property is omitted.
homepageUrl (string)
The address of the user's homepage, as a URL they provided. This property is omitted if the user has not provided a homepage.
id (string)
The URI from the related User object's id property.
interests (array<string>)
A list of interests provided by the user and displayed on their profile page.
location (string)
The user's location, as a free-form string they provided.
membershipManagementPageUrl (string)
The URL of a page where this user can manage their group memberships. If this is not the authenticated user's UserProfile object, this property is omitted.
preferredUsername (string)
The name the user has chosen for use in the URL of their TypePad profile page. This property can be used to select this user in URLs, although it is not a persistent key, as the user can change it at any time.
profileEditPageUrl (string)
The URL of a page where this user can edit their profile information. If this is not the authenticated user's UserProfile object, this property is omitted.
profilePageUrl (string)
The URL of the user's TypePad profile page.
urlId (string)
The canonical identifier from the related User object's urlId property.

Client Library Methods for PHP

Get a more extensive set of user properties that can be used to build a user profile page.
$tp->users->getProfile(array(

    # Required Parameters
    "id" => $id,

    # Optional Parameters
    "limit" => $limit,
    "offset" => $offset,

))

Example Request

GET /users/6p012877b13de7970c/profile.json?max-results=4 HTTP/1.1
Host: api.typepad.com

HTTP/1.0 200 OK
Content-type: application/json
Content-length: 696

{
   "urlId": "6p012877b13de7970c",
   "location": null,
   "interests": [],
   "followFrameContentUrl": "http://profile.typepad.com/services/embed/profile/6p012877b13de7970c/follow_module",
   "profilePageUrl": "http://profile.typepad.com/loblawatlaw",
   "aboutMe": null,
   "preferredUsername": "loblawatlaw",
   "id": "tag:api.typepad.com,2009:6p012877b13de7970c",
   "avatarLink": {
      "width": 250,
      "urlTemplate": "http://static.typepad.com/.shared:vf3ab36c:typepad:en_us/default-userpics/11-{spec}.gif",
      "url": "http://static.typepad.com/.shared:vf3ab36c:typepad:en_us/default-userpics/11-250si.gif",
      "height": 250
   },
   "displayName": "Bob Loblaw"
}