Getting a list of the members of a community
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 11, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Retrieve the members feed to view a list of the members who belong to a given community.
Tags: commapi

Discoverability

Web address in the href attribute of the <link> element that has a rel="http://www.ibm.com/xmlns/prod/sn/member-list" attribute value in the entry document of the community.

Request parameters

Use one or more of the input parameters to narrow the search. Separate multiple parameters with an ampersand (&).

Input
Method URI Description
GET /communities/service/atom/community/members Web address in the href attribute of the <link> element that has a rel="http://www.ibm.com/xmlns/prod/sn/member-list" attribute value in the entry document of the community.
Name Type Optional Description
asc
boolean Yes Specifies whether the results should be displayed in ascending order. Options are true or false.
email
string Yes Internet email address. Search for communities of which the user you specify by email address is a member.
Format the HTTP request using the proper URL encoding. For example, the encoded form of the @ symbol is %40 as in:
adam_eventide%40garden.com
Note: Do not use this parameter if IBM® Connections is configured to prevent email addresses from being displayed. Use the userid parameter instead.
This parameter is ignored if the userid parameter is provided. The role, since, page, ps, sortOrder, and asc parameters are ignored if this parameter is provided.
page
number Yes Page number. Specifies the page to be returned. The default value is 1, which returns the first page.
This parameter is ignored if the email or userid parameters are provided.
ps
int Yes Page size. Specifies the number of entries to return per page. The default value is 10. The maximum value you can specify is 10000.
This parameter is ignored if the email or userid parameters are provided.
role
enumerated Yes Returns only those people in the specified role. The options are:
all
member
owner
The default value for this parameter is all.
This parameter is ignored if the email or userid parameters are provided.
Authorized values:
  • all
  • member
  • owner
since
number Yes
Includes in the resulting feed all communities updated after a specified date. Specify the date using a date-time value that conforms to http://www.ietf.org/rfc/rfc3339.txt" target="external">RFC3339. Use an upper case "T" to separate the date and time, and an uppercase "Z" in the absence of a numeric time zone offset. For example: 2009-01-04T20:32:31.171Z.
This parameter is ignored if the email or userid parameters are provided.
sortBy
enumerated Yes
Specifies the order in which to sort the results. Options are:
created
Sorts the entries by the date the item was created.
title
Sorts the entries alphabetically by title. The title used is the text that is displayed in the <title> element of each entry in the feed.
Note: This parameter replaces the sortField parameter. The sortField parameter and its associated options (created and name) are supported for backwards compatibility only; they will be deprecated in a future release.
Authorized values:
  • created
  • title
sortOrder
enumerated Yes Specifies the order in which to sort the results. The options are:
asc
<a name="d7130e221"/>
Sorts the results in ascending order.
desc
<a name="d7130e226"/>
Sorts the results in descending order.
This parameter is ignored if the email or userid parameters are provided.
Authorized values:
  • asc
  • desc
userid
string Yes Unique ID that represents a specific person. Returns only the person specified by ID. The role, since, page, ps, sortOrder, and asc parameters are ignored if this parameter is provided.
communityUuid
string No The uuid of community that you want to query about. This is a mandatory parameter
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.