MePage API

by Luke Simpson, Justin Bodeutsch | Last edited: 2/11/2014

Display mode: addgallery

Show

nav
TagDescription
__galleriesurl__  
show
TagDescription
__descriptionfield__  
__formclose__  
__formopen__  
__namefield__  
__submitbutton__  

Display mode: addgalleryimage

Parameters

galleryid

Specifies the ID of the gallery that the image will be added to.

Example:

"galleryid:889102", 

Show

nav
TagDescription
__galleriesurl__  
__gallerydescription__  
__galleryname__  
__galleryurl__  
show
TagDescription
__descriptionfield__  
__formclose__  
__formopen__  
__gallerycoverfield__  
__imagefilefield__  
__namefield__  
__submitbutton__  

Display mode: blog

Parameters

restrict

Specifies whether or not the output is only viewable to logged-in members. Users are directed to the 404 Error Page for the site if they are not logged in.

Example:

"restrict:yes",

To provide a login screen instead of redirecting, make sure this parameter is completely removed from all member API calls. One can then use the following code to display a login screen for non-logged in users:

if (!$LOGGEDIN) {
    getContent(
        "login",
        "display:box",
        "createlink:no",
        "success:http://successfulURL"
    );
} else {...}

Show

nav
TagDescription
__newblogposturl__  
show
TagDescription
__date__  
__deleteurl__  
__editurl__  
__firstname__  
__fullname__  
__lastname__  
__message__  
__nickname__  
__picthumburl__  
__pictureurl__  
__slug__  
__title__  
__url__  
__username__  
__ commentNumber__ The number of comments, formatted "Comments(X)"
__commentNumberonly__ The number of comments with no wrapper
noshow
TagDescription
__firstname__  
__fullname__  
__lastname__  
__nickname__  
__picthumburl__  
__pictureurl__  
__username__  

Display mode: blogpost

Parameters

find

...

Example:

"find:blogpost-slug", 

restrict

Specifies whether or not the output is only viewable to logged-in members.

Example:

"restrict:yes", 

Show

nav
TagDescription
__blogurl__  
show
TagDescription
__date__  
__deleteurl__  
__editurl__  
__firstname__  
__fullname__  
__lastname__  
__message__  
__nickname__  
__picthumburl__  
__pictureurl__  
__slug__  
__title__  
__username__  
__ commentNumber__ The number of comments, formatted "Comments(X)"
__commentNumberonly__ The number of comments with no wrapper
__ commentList__ Preformatted list of comments with a form to add comments

Display mode: deleteblogpost

Show

nav
TagDescription
__blogposturl__  
__blogurl__  
show
TagDescription
__deleteurl__  
__formclose__  
__formopen__  
__submitbutton__  

Display mode: deletegallery

Parameters

galleryid

Specifies the ID of the gallery to be deleted.

Example:

"galleryid:889102", 

Show

nav
TagDescription
__galleriesurl__  
__gallerydescription__  
__galleryname__  
__galleryurl__  
show
TagDescription
__deleteurl__  
__formclose__  
__formopen__  
__submitbutton__  

Display mode: deletegalleryimage

Parameters

galleryid

Specifies the ID of the gallery that the requested image belongs to.

Example:

"galleryid:889102", 

imageid

Specifies the ID of the image to be deleted.

Example:

"image:589109", 

Show

nav
TagDescription
__galleriesurl__  
__gallerydescription__  
__galleryname__  
__galleryurl__  
__imageurl__  
show
TagDescription
__deleteurl__  
__formclose__  
__formopen__  
__submitbutton__  

Display mode: deletemessage

Parameters

findid

...

Example:

"findid:5891", 

Show

show
TagDescription
__deleteurl__  
__formclose__  
__formopen__  
__hiddenfields__  
__submitbutton__  

Display mode: detail

Parameters

find

...

Example:

"find:memberusername", 

findid

...

Example:

"findid:5891", 

restrict

Specifies whether or not the output is only viewable to logged-in members.

Example:

"restrict:yes", 

Show

show
TagDescription
__activitylinks__  
__address__  
__addresscity__  
__addresscountry__  
__addressstate__  
__addressstreet__  
__addresszipcode__  
__birthdate__  
__booklinks__  
__cellphone__  
__comment__  
__educlassyear1__  
__educlassyear2__  
__educlassyear3__  
__educlassyearlink1__  
__educlassyearlink2__  
__educlassyearlink3__  
__edudegreeone1__  
__edudegreeone2__  
__edudegreeone3__  
__edudegreethree1__  
__edudegreethree2__  
__edudegreethree3__  
__edudegreetwo1__  
__edudegreetwo2__  
__edudegreetwo3__  
__edulevel1__  
__edulevel2__  
__edulevel3__  
__eduname1__  
__eduname2__  
__eduname3__  
__edunamelink1__  
__edunamelink2__  
__edunamelink3__  
__emailaddress__  
__emailaddressencoded__  
__firstname__  
__flickr__  
__fullname__  
__headercontact__  
__headereducation__  
__headeronline__  
__headerpersonal__  
__headervehicle__  
__headerwork__  
__homephone__  
__interestlinks__  
__lastname__  
__movielinks__  
__musiclinks__  
__nickname__  
__photogallery__  
__picthumburl__  
__pictureurl__  
__podcast__  
__rssfeed__  
__smallgroup__  
__tvshowlinks__  
__username__  
__vehicle__  
__vehiclemake__  
__vehiclemodel__  
__vehiclemods__  
__vehicletrail__  
__vehicleyear__  
__website__  
__workdescription1__  
__workdescription2__  
__workdescription3__  
__workemployer1__  
__workemployer2__  
__workemployer3__  
__workenddate1__  
__workenddate2__  
__workenddate3__  
__workphone__  
__workposition1__  
__workposition2__  
__workposition3__  
__workstartdate1__  
__workstartdate2__  
__workstartdate3__  
Any Custom Fields setup for Users will output their API tags

Display mode: directory

Parameters

find_group

Limits results to members of specified groups. If multiple groups are listed, members of ANY listed group are returned.

Example:

"find_group:men,women,high-school",

show_to_groups

Will return nothing if user isn't a member of the specified groups. Multiple groups should be comma separated.

Example:

"show_to_groups:men,women,high-school",
letter

Specifies the letter of the directory to view. If no letter is specified, the entire directory is returned.

Example:

"letter:j", 

restrict

Specifies whether or not the output is only viewable to logged-in members.

Example:

"restrict:yes", 

Show

nav
TagDescription
__alphabet__ Ordered list of letters A-Z. If a member exists with the last name of 'Stayton', for example, 'S' is linked to view that letter in the directory; if not, the letter is not linked.
__viewall__ URL to view the entire directory at once.
show
TagDescription
__firstname__ First name of member.
__fullname__ Full name of member.
__lastname__ Last name of member.
__nickname__ Nickname of member.
__picthumburl__ URL to thumbnail of member's profile picture.
__pictureurl__ URL to member's profile picture.
__profileurl__ URL to member's profile.
__username__ Username of member.

Display mode: editblogpost

Show

nav
TagDescription
__blogposturl__  
__blogurl__  
show
TagDescription
__formclose__  
__formopen__  
__messagefield__  
__submitbutton__  
__titlefield__  

Display mode: editgallery

Parameters

galleryid

Specifies the ID of the gallery to be edited.

Example:

"galleryid:889102", 

Show

nav
TagDescription
__galleriesurl__  
__gallerydescription__  
__galleryname__  
__galleryurl__  
show
TagDescription
__descriptionfield__  
__formclose__  
__formopen__  
__namefield__  
__submitbutton__  

Display mode: editgalleryimage

Parameters

galleryid

Specifies the ID of the gallery that the requested image belongs to.

Example:

"galleryid:889102", 

imageid

Specifies the ID of the image to be edited.

Example:

"imageid:589109", 

Show

nav
TagDescription
__galleriesurl__  
__gallerydescription__  
__galleryname__  
__galleryurl__  
__imageurl__  
show
TagDescription
__descriptionfield__  
__formclose__  
__formopen__  
__gallerycoverfield__  
__namefield__  
__submitbutton__  

Display mode: editprofile

Show

section:contact
TagDescription
__cityfield__  
__countryfield__  
__emailaddressfield__  
__firstnamefield__  
__formclose__  
__formopen__  
__lastnamefield__  
__phonecellfield__  
__phonehomefield__  
__phoneworkfield__  
__stateotherfield__  
__stateusfield__  
__streetfield__  
__submitbutton__  
__zipcodefield__  
section:education
TagDescription
__formclose__  
__formopen__  
__school2divclose__  
__school2divopen__  
__school3divclose__  
__school3divopen__  
__schooladd2divclose__  
__schooladd2divopen__  
__schooladd2link__  
__schooladd3divclose__  
__schooladd3divopen__  
__schooladd3link__  
__schooladddegreethree1divclose__  
__schooladddegreethree1divopen__  
__schooladddegreethree1link__  
__schooladddegreethree2divclose__  
__schooladddegreethree2divopen__  
__schooladddegreethree2link__  
__schooladddegreethree3divclose__  
__schooladddegreethree3divopen__  
__schooladddegreethree3link__  
__schooladddegreetwo1divclose__  
__schooladddegreetwo1divopen__  
__schooladddegreetwo1link__  
__schooladddegreetwo2divclose__  
__schooladddegreetwo2divopen__  
__schooladddegreetwo2link__  
__schooladddegreetwo3divclose__  
__schooladddegreetwo3divopen__  
__schooladddegreetwo3link__  
__schoolclassyear1field__  
__schoolclassyear2field__  
__schoolclassyear3field__  
__schooldegreeone1divclose__  
__schooldegreeone1divopen__  
__schooldegreeone1field__  
__schooldegreeone2divclose__  
__schooldegreeone2divopen__  
__schooldegreeone2field__  
__schooldegreeone3divclose__  
__schooldegreeone3divopen__  
__schooldegreeone3field__  
__schooldegreeoneremove1link__  
__schooldegreeoneremove2link__  
__schooldegreeoneremove3link__  
__schooldegreethree1divclose__  
__schooldegreethree1divopen__  
__schooldegreethree1field__  
__schooldegreethree2divclose__  
__schooldegreethree2divopen__  
__schooldegreethree2field__  
__schooldegreethree3divclose__  
__schooldegreethree3divopen__  
__schooldegreethree3field__  
__schooldegreethreeremove1link__  
__schooldegreethreeremove2link__  
__schooldegreethreeremove3link__  
__schooldegreetwo1divclose__  
__schooldegreetwo1divopen__  
__schooldegreetwo1field__  
__schooldegreetwo2divclose__  
__schooldegreetwo2divopen__  
__schooldegreetwo2field__  
__schooldegreetwo3divclose__  
__schooldegreetwo3divopen__  
__schooldegreetwo3field__  
__schooldegreetworemove1link__  
__schooldegreetworemove2link__  
__schooldegreetworemove3link__  
__schoollevel1field__  
__schoollevel2field__  
__schoollevel3field__  
__schoolname1field__  
__schoolname2field__  
__schoolname3field__  
__schoolremove1link__  
__schoolremove2link__  
__schoolremove3link__  
__submitbutton__  
section:online
TagDescription
__flickrfield__  
__formclose__  
__formopen__  
__photogalleryfield__  
__podcastfield__  
__rssfield__  
__submitbutton__  
__websitefield__  
section:personal
TagDescription
__aboutfield__  
__activitiesfield__  
__birthdayfield__  
__birthmonthfield__  
__birthyearfield__  
__booksfield__  
__formclose__  
__formopen__  
__interestsfield__  
__moviesfield__  
__musicfield__  
__nicknamefield__  
__submitbutton__  
__tvshowsfield__  
section:picture
TagDescription
__formclose__  
__formopen__  
__picturefilefield__  
__submitbutton__  
section:privacy
TagDescription
__formclose__  
__formopen__  
__notifyonfriendrequestfield__  
__notifyonmessagefield__  
__privacyeveryonefield__  
__privacyfriendsfield__  
__privacymembersfield__  
__privacynoonefield__  
__submitbutton__  
section:vehicle
TagDescription
__formclose__  
__formopen__  
__makefield__  
__modelfield__  
__modsfield__  
__submitbutton__  
__trailfield__  
__yearfield__  
section:work
TagDescription
__formclose__  
__formopen__  
__submitbutton__  
__work2divclose__  
__work2divopen__  
__work3divclose__  
__work3divopen__  
__workadd2divclose__  
__workadd2divopen__  
__workadd2link__  
__workadd3divclose__  
__workadd3divopen__  
__workadd3link__  
__workcurrentjob1field__  
__workcurrentjob2field__  
__workcurrentjob3field__  
__workdescription1field__  
__workdescription2field__  
__workdescription3field__  
__workemployer1field__  
__workemployer2field__  
__workemployer3field__  
__workenddatepast1spanclose__  
__workenddatepast1spanopen__  
__workenddatepast2spanclose__  
__workenddatepast2spanopen__  
__workenddatepast3spanclose__  
__workenddatepast3spanopen__  
__workenddatepresent1spanclose__  
__workenddatepresent1spanopen__  
__workenddatepresent2spanclose__  
__workenddatepresent2spanopen__  
__workenddatepresent3spanclose__  
__workenddatepresent3spanopen__  
__workmonthend1field__  
__workmonthend2field__  
__workmonthend3field__  
__workmonthstart1field__  
__workmonthstart2field__  
__workmonthstart3field__  
__workposition1field__  
__workposition2field__  
__workposition3field__  
__workremove1link__  
__workremove2link__  
__workremove3link__  
__workyearend1field__  
__workyearend2field__  
__workyearend3field__  
__workyearstart1field__  
__workyearstart2field__  
__workyearstart3field__  

Display mode: friendrequests

Show

show
TagDescription
__approveurl__  
__denyurl__  
__firstname__  
__fullname__  
__lastname__  
__message__  
__nickname__  
__picthumburl__  
__pictureurl__  
__profileurl__  
__username__  

Display mode: friends

Parameters

restrict

Specifies whether or not the output is only viewable to logged-in members.

Example:

"restrict:yes", 

Show

nav
TagDescription
__friendrequestsurl__  
__friendrequestscount__  
show
TagDescription
__firstname__  
__fullname__  
__lastname__  
__nickname__  
__picthumburl__  
__pictureurl__  
__profileurl__  
__username__  

Display mode: galleries

Parameters

restrict

Specifies whether or not the output is only viewable to logged-in members.

Example:

"restrict:yes", 

Show

nav
TagDescription
__addgalleryurl__  
show
TagDescription
__coverimageurl__  
__coverthumburl__  
__date__  
__deleteurl__  
__description__  
__editurl__  
__name__  
__url__  
galleryid

Specifies the ID of the gallery to be viewed.

Example:

"galleryid:889102", 

restrict

Specifies whether or not the output is only viewable to logged-in members.

Example:

"restrict:yes", 

nav
TagDescription
__addimageurl__  
__galleriesurl__  
__gallerydescription__  
__galleryname__  
show
TagDescription
__date__  
__deleteurl__  
__description__  
__editurl__  
__imageurl__  
__movedownurl__  
__moveupurl__  
__name__  
__thumburl__  
__url__  

Display mode: galleryimage

Parameters

galleryid

Specifies the ID of the gallery that the requested image belongs to.

Example:

"galleryid:889102", 

imageid

Specifies the ID of the image to be viewed.

Example:

"imageid:589109", 

restrict

Specifies whether or not the output is only viewable to logged-in members.

Example:

"restrict:yes", 

Show

nav
TagDescription
__galleriesurl__  
__gallerydescription__  
__galleryname__  
__galleryurl__  
show
TagDescription
__date__  
__deleteurl__  
__description__  
__editurl__  
__imageurl__  
__name__  
__thumburl__  

Display mode: messages

Show

show
TagDescription
__date__  
__deleteurl__  
__firstname__  
__flag__  
__fullname__  
__lastname__  
__message__  
__nickname__  
__picthumburl__  
__pictureurl__  
__profileurl__  
__replyurl__  
__username__  

Display mode: newblogpost

Show

show
TagDescription
__formclose__  
__formopen__  
__messagefield__  
__submitbutton__  
__titlefield__  

Display mode: removefriend

Show

show
TagDescription
__formclose__  
__formopen__  
__hiddenfields__  
__removeurl__  
__submitbutton__  

Display mode: requestfriend

Show

show
TagDescription
__formclose__  
__formopen__  
__hiddenfields__  
__messagefield__  
__submitbutton__  

Parameters

show_to_groups

Will return nothing if user isn't a member of the specified groups. Multiple groups should be comma separated.

Example:

"show_to_groups:men,women,high-school",restrict

Specifies whether or not the output is only viewable to logged-in members.

Example:

"restrict:yes", 

Show

show
TagDescription
__directoryurl__ URL to member directory (an alternate option to searching).
__formclose__ Closing form tag.
__formopen__ Opening form tag with the required action and method attributes.
__searchfield__ Text input field with the name and id attributes set to 'keywords'.
Parameters
size
Specifies the size of the input field. If nothing is specified, '20' is used for the default value.
__submitbutton__ Submit button with the name and id attributes set to 'searchSubmit'.
Parameters
value
Specifies the text value of the submit button. If nothing is specified, 'Search' is used for the default value.

Display mode: searchresults

Parameters

find_group

Limits results to members of specified groups. If multiple groups are listed, members of ANY listed group are returned.

Example:

"find_group:men,women,high-school",

show_to_groups

Will return nothing if user isn't a member of the specified groups. Multiple groups should be comma separated.

Example:

"show_to_groups:men,women,high-school",
criteria

Specifies which field to search: 'interest', 'activity', 'music', 'movie', 'tvshow', 'book', or 'education'. If no criteria is specified, name is searched by default.

Example:

"criteria:music", 

restrict

Specifies whether or not the output is only viewable to logged-in members.

Example:

"restrict:yes", 

search

Specifies the string to search the specified criteria for.

Example:

"search:Radiohead", 

Show

show
TagDescription
__firstname__ First name of member who matches search.
__fullname__ Full name of member who matches search.
__lastname__ Last name of member who matches search.
__nickname__ Nickname of member who matches search.
__picthumburl__ URL to thumbnail of member's profile picture.
__pictureurl__ URL to member's profile picture.
__profileurl__ URL to member's profile.
__username__ Username of member who matches search.

Display mode: sendmessage

Parameters

replyid

...

Example:

"replyid:8891", 

Show

show
TagDescription
__formclose__  
__formopen__  
__hiddenfields__  
__messagefield__  
__submitbutton__  

Display mode: summary

Parameters

find

Specifies the member username or e-mail address to view.

Example:

"find:memberusername", 

findid

Specifies the member ID to view.

Example:

"findid:5891", 

restrict

Specifies whether or not the output is only viewable to logged-in members.

Example:

"restrict:yes", 

style

Specifies the URL of the stylesheet to feed into the edit profile thickbox.

Example:

"style:http://www.location.of/style/sheet.css", 

success

Specifies the URL of the success page.

Example:

"success:http://www.location.of/success/page.html", 

Show

show
TagDescription
__blogurl__ URL to member's blog.
__directoryurl__ URL to member directory.
__editprofileurl__ URL to edit member's profile. This should display in a thickbox 500px by 410px in size. Only returns when member is viewing his or her own profile.
__firstname__ First name of member.
__friendrequestscount__ Number of pending friend requests. Only returns when member is viewing his or her own profile and has pending friends.
__friendrequestsurl__ URL to member's friend requests. Only returns when member is viewing his or her own profile.
__friendsurl__ URL to member's friends.
__fullname__ Full name of member.
__galleriesurl__ URL to member's galleries.
__lastname__ Last name of member.
__messageurl__ URL to member's messages. Only returns when member is viewing his or her own profile.
__newblogposturl__ URL to make a new member blog post. Only returns when member is viewing his or her own profile.
__newmessagecount__ Number of new messages. Only returns when member is viewing his or her own profile and has unread messages.
__nickname__ Nickname of member.
__ordersurl__ URL to member's order history. Only returns when member is viewing his or her own profile.
__picthumburl__ URL to thumbnail of member's profile picture.
__pictureurl__ URL to member's profile picture.
__profileurl__ URL to member's profile.
__queueurl__ URL to member's product queue. Only returns when member is viewing his or her own profile.
__removefriendurl__ URL to remove member as friend. Only returns when member is viewing a friend.
__requestfriendurl__ URL to request member as friend. Only returns when member is viewing a non-friend.
__sendmessageurl__ URL to send message to member. Only returns when member is viewing a profile other than his or her own.
__username__ Username of member, or e-mail address if member has no username.
Any Custom Fields setup for Users will output their API tags