Retrieve profile tags 

To retrieve the tags assigned to a profile from the Profiles tag collection, use a HTTP GET request to retrieve the tags category document for that profile.

You can retrieve tags created by any user for any user.

Table 1. Atom API request details

Method Resource URI Output representation
GET Atom category document /atom/profileTags.do Atom category document of Profiles tags

Table 2. Required input parameters

Parameter Description
format Specifies how much tag information you want to retrieve. The options are:

  • lite. Returns a list of the tags, and indicates how many times the tag was assigned to a profile. Specify format=full to also return information about which users have applied each tag. The default is format=lite.

  • full. Returns a list of the tags, how many times they were assigned, and who created them.

The default value is lite.

targetEmail Specifies the email address of the person whose profile you want to apply the updated tags to. Provide one target parameter, either this option or the targetKey option.
targetKey Specifies the unique ID of the person whose profile you want to apply the updated tags to. Provide one target parameter, either this option or the targetEmail option.

Table 3. Optional additional parameters

Parameter Description
sourceEmail Specifies the email address of the creator of the tags. If you specify a source parameter at all, specify either this option or the sourceKey option.
sourceKey Specifies the unique ID of the creator of the tags. If you specify a source parameter at all, specify either this option or the sourceEmail option.


Note: An example of when you might want to use one of the source parameters is if you had tagged a person's profile. For example, you tagged Sandy's profile. Now you want to add a new tag to the set. First, you retrieve the existing tags, and then update them. To retrieve the existing tags, you specify Sandy's information using a target parameter and provide your email or key using a source parameter.


Input

None.


Output

A category Atom document of Profiles tags. The content type of the Atom document is application/atomcat+xml.

Returned HTTP headers

HTTP/1.1 200 OK

Content-Type: application/atomcat+xml


Parent topic

Work with profile tags

Related reference
Tags category document
Update profile tags


   

 

});