IBM Connections People API
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 30, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

The people API is intended to provide basic person data to gadgets hosted by IBM Connections. The current implementation returns only a minimal subset of the total data model supported by OpenSocial in order to make some of the other Open Social APIs easier to use (namely the ActivityStreams and Microblogging API). It is not intended to be a full implementation and contains no support for the retrieval of relationships (such as the people in a given users network). It is expected that this support will be introduced in subsequent versions of IBM Connections.

Summary of limitations

Many fields in the implementation of the Shindig interface are currently ignored, these include the parameters:
  • groupId
  • collectionOptions
  • fields
An empty person is returned if a request is made without first logging in. Any request for a person or people will return opensocial person objects as specified by the given userId(s) and securityToken which contain:
  • displayName
  • email (nested in a listfield)
  • id (relating to waltz)

Convenience methods such as osapi.people.getViewer() will NOT work immediately, it is advised that the osapi.people.get() method is used instead, which defaults to viewer anyway. The following list of parameters is not exhaustive.
Method URI Description
GET /connections/opensocial/{auth}/rest/people/{userId}/{groupId} Provide basic person data to gadgets hosted by IBM Connections
Name Type Optional Description
string No possible values include @me, @viewer, @owner or an actual id or array of ids (opensocial regards login names as IDs, using a connections ID here will NOT work). defaults to @me
string No possible values include @self, @friends and @all. defaults to @self - meaning the actual userId or userIds given under userId. groupIds other than @self are NOT currently supported.
enumerated No The authorization protocol being used by your application to access Connections Cloud.
Authorized values:
  • basic
  • oauth
Name Type Optional Description
string Yes possible values include displayName and id. this parameter is currently IGNORED by the API, may be implemented in the future.
Name Type Optional Description
enumerated No The authentication mechanism selected by your application to access the API.
Basic is the Base64 encoding of the IBM Connections Cloud username and password: Base64(username:password). For example, Base64(
Bearer is the oauth 2.0 access token that is generated when the user grants your application access to IBM Connections Cloud services.
See the reference topic "OAuth 2.0 APIs for web server flow" for more information.
Authorized values:
  • bearer
  • basic
Content Type: application/json
Code Description
Unauthorized. Returned when no authenticated user or no userid, email, or key parameter are provided on the request.
Example JSON output from rest-api call to "connections/opensocial/rest/people/@me/@self" :

Response returned by the server

  "entry": {





        "primary" : true,

        "type": "primary"


    "displayName": "AN Other"